之前换了新的单位后,单位的项目有使用到swagger,那个时候觉得这个好方便,后面是建立在他们搭建好的基础上使用一些swagger的注解,但一直想要自己去实现,奈何没有机会,这次机会终于来了,完成从0开始,虽然说这个不难,但之前自己没有搭建过,还是遇到了一点问题,好在站在了巨人的肩膀上把问题解决了。
当然如果不使用swagger也可以直接在word中编写接口文档,接口文档主要是给产品,测试,前端看的,由后端同学去维护。
感谢大神!感兴趣的也去看下第一篇文档,第二篇是解决问题的。
swagger接口文档
前提条件:我使用的springboot的版本是jdk版本是11
我这里使用的是SpringFox,它是spring社区维护的一个非官方的开源的APIDoc的框架,MartyPitt编写了一个基于Spring的组件swagger-springmvc,用于将swagger集成到springmvc中来,它的前身是swagger-springmvc,可以将我们的Controller中的方法以文档的形式展现。
SpringFox0.0发布,支持OpenApi0.有springboot的整合的starter,使用更便捷基于OpenAPi规范-新版SpringBootx整合Swaggerx。
2SpringBoot添加pom文件依赖
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>
3swagger的配置类
文章为作者独立观点,不代表 股票程序化软件自动交易接口观点