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

时间:2026-02-12 14:18:28

1、引入swagger依赖,如下图所示。

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

2、在启动类的同级目录下创建Swagger2类,作为配置类,如下图所示。

★通过@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

© 2026 途途旅游
信息来自网络 所有数据仅供参考
有疑问请联系站长 site.kefu@gmail.com