如何使用swagger进行多人协同开发

电脑:联想笔记本、系统Windows10
Spring Tool Suite 4方式/
1引入swagger依靠 , 如下图所示 。

如何使用swagger进行多人协同开发

文章插图

2在启动类的同级目次下建立Swagger2类 , 作为设置装备摆设类 , 如下图所示 。
【如何使用swagger进行多人协同开发】★经由过程@Configuration标识表记标帜此类为设置装备摆设类 , 会在SpringBoot项目启动的时辰加载 , @EnableSwagger2用来启动Swagger 。
★Swagger会主动扫描我们设置装备摆设的cn.com.wenyi.controller包下的接口主动生当作接口文档 。

如何使用swagger进行多人协同开发

文章插图

3在Controller类上利用@Api注解 , 如下图所示 。

如何使用swagger进行多人协同开发

文章插图

4在方式上利用@ApiOperation注解来给API增添方式申明 , 如下图所示 。

如何使用swagger进行多人协同开发

文章插图

5在方式上利用@ApiImplicitParams或者@ApiImplicitParam注解 , 用来给方式入参增添申明 , 如下图所示 。

如何使用swagger进行多人协同开发

文章插图

如何使用swagger进行多人协同开发

文章插图

6在实体类上利用@ApiModel注解 , 描述一个Model的信息 , 如下图所示 。

如何使用swagger进行多人协同开发

文章插图

7在实体类的属于变量上利用@ApiModelProperty , 描述一个model的属性 , 如下图所示 。

如何使用swagger进行多人协同开发

文章插图

8启动Spring Boot程序 , 拜候:http://localhost:8080/swagger-ui.html , 看看显示结果 , 如下图所示 。

如何使用swagger进行多人协同开发

文章插图

9总结:
1、引入swagger依靠
2、建立Swagger2类 , 利用@Configuration与@EnableSwagger2
3、利用@Api
4、利用@ApiOperation
5、利用@ApiImplicitParams或者@ApiImplicitParam
6、利用@ApiModel
7、利用@ApiModelProperty
8、拜候:http://localhost:8080/swagger-ui.html


以上内容就是如何使用swagger进行多人协同开发的内容啦 , 希望对你有所帮助哦!

    推荐阅读