idea swagger生成接口文档_使用swagger来做API文档

[swagger集成springMVC框架,自动生成接口文档与测试框架。]

使用Spring boot可以很快速的开发restful api,但是如果手工维护api文档就太费事了,很难做到同步。

swagger可以将代码和api文档维护在一起,通过访问服务进程的swagger页面就可以得到完善的api文档,还可以直接Try out。

swagger的使用,可以参考 程序员DD 的这篇文章: Spring Boot中使用Swagger2构建强大的RESTful API文档 ,快速开始,原文写的很好,我就不搬运了。总的来说,还是很方便的。

由于我的应用还配置了spring security,在与swagger配合的时候遇到了一些问题,记录一下,也许对你有用。[有很多读者问过这样的一个问题:虽然使用Swagger可以为Spring MVC编写的接口生成了API文档,但是在微服务化之后,这些API文档都离散在各个微服务中,是否有办法将这些接口

第一个问题是,不要在IDEA里直接Run Spring Boot Application。之前图方便,一直是这样跑的,但发现这样在加载swagger的静态资源的时候,会有下面的 Not Found 问题。改成 JAR Application 就正常了。

This application has no explicit mapping for /error, so you are seeing this as a fallback.

Wed Jan 10 11:56:24 IST 2018

There was an unexpecte

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值