以前开发项目,生成文档都是用的, 但是这个不是实时在线的,所以使用 实时在线文档来开发项目。
以下文章转载其他人写的教程。相关详细说明,建议还是阅读Swagger2官方文档比较好。
1、什么是swagger?
2、swagger的作用是什么?
- 1)接口的文档在线自动生成。
- 2)功能测试。
3、swagger如何使用?
第一步:导入swagger依赖包
第二步:创建swagger配置文件

4、注解及其说明
@Api : ,描述该类的主要作用。
@ApiOperation:,给API增加方法描述。
@ApiImplicitParams : 用在方法上,包含一组参数描述。
@ApiImplicitParam:用来注解来给方法入参增加描述。
@ApiResponses:用于表示一组响应。
@ApiResponse:用在@ApiResponses中,一般用于表达一个错误的响应信息。
code:数字,例如500
message:信息,例如"请求参数异常"
response:抛出异常的类
@ApiModel:,描述一个Model的信息(一般用在请求参数无法使用ApiImplicitParam注解进行描述的时候)。
@ApiModelProperty:。
5.关闭Swagger有两种方式
方式一:
在Swagger2Config上使用注解标识,表示在dev和test环境才能访问swagger-ui.html,prod环境下访问不了。
方式二:
在Swagger2Config上使用@ConditionalOnProperty注解,
表示配置文件中如果swagger.enable =true表示开启。所以只需要在开发环境的配置文件配置为true,生产环境配置为false即可。
个人建议使用第一种方法。
到此这篇swagger2关闭(swagger怎么关闭)的文章就介绍到这了,更多相关内容请继续浏览下面的相关推荐文章,希望大家都能在编程的领域有一番成就!版权声明:
本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如若内容造成侵权、违法违规、事实不符,请将相关资料发送至xkadmin@xkablog.com进行投诉反馈,一经查实,立即处理!
转载请注明出处,原文链接:https://www.xkablog.com/rfx/33713.html