swagger

• 如何在生成环境禁用swagger?

今天在看一篇博客时，看到在项目的类，方法 上写api注释的，觉得很好的一个想法。后来查了一下，这个是专门用来生成restful风格的接口文档的一种实现方式，有了它，就不需要手动写接口文档，也避免了代码和文档的不一致问题。

只要注意，在写代码时，养成按照swagger插件的格式，写上对应的注释即可，这样后续的内容，swagger都会帮我们实现好。也就是靠代码来维护文档。

官网地址为：https://swagger.io/ 

中文网站：http://www.sosoapi.com

参考：http://www.sosoapi.com/pass/apidoc/demo.htm#!/%E8%BF%9B%E9%98%B6/get_user_complex_list_htm

它现在可以和spring,spring-boot结合，我下载了网上的一个实现：

http://localhost:8080//server-api/index.html#!/

这个是springMvc项目，结合swagger的实现

项目地址为：http://git.oschina.net/fansunion/swagger-server-api/tree/master/

博客介绍为：https://blog.csdn.net/FansUnion/article/details/51923720

使用：

在后期代码实现中，导入相关依赖，代码中加上相关注解，为文档生成做准备

关于禁用，网上有一些博客，参考：https://blog.csdn.net/weixin_37591536/article/details/82115325

 

 

20200629

https://mp.weixin.qq.com/s/0-c0MAgtyOeKx6qzmdUG0w   swagger的讲解文档

swagger 个人感觉，

1因为文档是基于代码生成的，不可避免的会有些注解，会侵入代码。而无法直接在文档里编写注释。

这个它相比Yapi的我觉得不便的地方；

2 如果是多个项目，每个都是一个大型项目的组成部分，而我又想通过一个网址，整体查看得到。而不是跟着一个项目一个swagger-ui.html这样打开，想要有一个统一的管理，不知道swagger能否实现；

3 关于界面，css，文档下面有提及，可以通过引入想要的样式依赖，来达到界面风格的更换；

4 基于以上几点，如果是一个项目整体，在一个project的话，我觉得是可以使用的，同时可以通过配置，关闭正式环境的文档生成；

5关于上面提到的swagger整合，在springboot单个项目上，没又文章可做，但若是引入了springcloud类似网关的概念后，就相当于有了个聚合项目，在这里就可以实现swagger的集成多项目文档，至于实现，我还没看，只是个想法