swagger 超简单入门教程 使用(真实自测)

版权声明:第一次写文章,有什么需要补充的还望各位大神多多指教。 https://blog.csdn.net/mengxiangxingdong/article/details/82743687

ps

网上swagger 的资料比较多,开发时还是遇到不少坑的,所以自己进行一下整理自己的学习过程

教程:(如果想快速入门,强烈建议,链接中的博客暂时只看我建议的部分)

—————————–我是无敌的搬运工(如有需要,我会整合成一个系列文章)———————————

1.安装,集成到springboot

方式一 纯注解式
http://blog.didispace.com/spring-boot-starter-swagger-1.1.0/
方式二 引用jar 自配
https://blog.csdn.net/xxoo00xx00/article/details/77278510

2.常用注解

https://www.jianshu.com/p/12f4394462d5
ps: 有些写的有点问题,不影响常用
后面会写一篇swagger 注解大全

3.常见问题

1.swagger 如何显示中文

https://www.jianshu.com/p/7e543f0f0bd8

2. @ApiModel 返回内容注释不显示问题

ps:swagger 返回的泛型类中如果带有泛型集合类,是不会返回具体的注释的,会认为是一个array
https://blog.csdn.net/qq_32917699/article/details/81486060

3.常见坑

http://www.cnblogs.com/xiebq/p/9508848.html

4.怎么描述json 参数

https://blog.csdn.net/u014745069/article/details/80246803

5.swagger 忽略字段

6.如何改变swagger请求的url

https://blog.csdn.net/cooledi/article/details/78599384

7.忽略有些类不显示

@ApiIgnore()
于类或者方法上,可以不被swagger显示在页面上
比较简单, 这里不做举例

4.编写规范建议

https://blog.csdn.net/xxoo00xx00/article/details/77278510

5.换其他界面风格

1.bootstrap版本

http://www.360doc.com/content/17/1115/21/16915_704165894.shtml

2.layui

https://blog.csdn.net/tuposky/article/details/77965139

自己的心得扩展

单独写一篇博客

猜你喜欢

转载自blog.csdn.net/mengxiangxingdong/article/details/82743687