如何使用swagger进行多人协同开发
1、引入swagger依赖,如下图所示。
2、在启动类的同级目录下创建Swagger2类,作为配置类,如下图所示。★通过@Con酆璁冻嘌figuration标记此类为配置类,会在SpringBoot项目启动的时候加载,@EnableSwagger2用来启动Swagger。★Swagger会自动扫描我们配置的cn.com.wenyi.controller包下的接口自动生成接口文档。
3、在Controller类上使用@Api注解,如下图所示。
4、在方法上使用@ApiOperation注解来给API增加方法说明,如下图所示。
5、在方法上使用@ApiImplicitParams或者@ApiImplicitParam注解,用来给方法入参增加说明,如下图所示。
6、在实体类上使用@ApiModel注解,描述一个Model的信息,如下图所示。
7、在实体类的属于变量上使用@ApiModelProperty,描述一个model的属性,如下图所示。
8、启动Spring Boot程序,访问:http://localhost:8080/swagger-ui.html,看看显示效果,如下图所示。
9、总结:1、引入swagger依赖2、创建Swagger2类,使用@Configuration与@EnableSwagger23、使用@Api4、使用@ApiOperation5、使用@ApiImplicitParams或者@ApiImplicitParam6、使用@ApiModel7、使用@ApiModelProperty8、访问:http://localhost:8080/swagger-ui.html
声明:本网站引用、摘录或转载内容仅供网站访问者交流或参考,不代表本站立场,如存在版权或非法内容,请联系站长删除,联系邮箱:site.kefu@qq.com。
阅读量:42
阅读量:44
阅读量:40
阅读量:23
阅读量:91