Spring Boot使用SpringFox自动生成Api Doc

在做Android开发的时候,对于Api接口的对接有着深刻的体会:后端通过Markdown或者Word写好Api文档,然后通过类似Samba或者Dropbox这样的服务与移动端实现文档共享。有的时候因为接口出了问题,中间还得来回修改对接,效率低下不说,要是后端手抖写错参数而没有意识到,移动端埋头一顿调试。。。说多了都是泪。

为了避免同时维护代码和文档来保持两者之间的同步而带来的额外负担,同事推荐了 ApiDoc 来生成文档,虽然生成的文档界面比较清爽然而前提是必须得按照规定的语法写上详细的注释,才能生成对应的文档,虽然写注释本身是一件好事,不过有能够自动生成的方法为啥不使用呢?

Apidoc 类似, Swagger 也是一个用来文档化Resetful Api的项目,不过开源社区的支持应该是所有类似项目中最为完善的,因此除了可以使用 Swagger Editor 来编写Api文档之外,你还可以使用其它对应的自动化生成工具,以此来避免同时维护文档和代码的麻烦:

  • Springfox 是为Spring而打造的自动化生成接口文档的其中一个Java实现
  • Django Reset Swagger 则是为Django而打造的Python实现。

这篇文章将从头创建一个Spring Boot项目并使用Springfox来生成对应的接口文档,来说明使用Springfox是多么的简单。首先创建Spring Boot项目:

创建Spring Boot项目

Eclipse

如果你是使用Eclipse的话,那么:

Spring Boot使用SpringFox自动生成Api Doc

IntelliJ IDEA

我们使用IDEA的 Spring initializr 向导来简化初始化创建项目,如图所示:

Spring Boot使用SpringFox自动生成Api Doc

点击下一步根据个人的喜好来配置喜欢的JVM语言和构建工具,此处我选择 KotlinGradle ,一切都是为了爽:

Spring Boot使用SpringFox自动生成Api Doc

原文 

https://notes.wanghao.work/2017-06-30-Spring-Boot使用Swagger自动生成Api-Doc.html

PS:如果您想和业内技术大牛交流的话,请加qq群(527933790)或者关注微信公众 号(AskHarries),谢谢!

转载请注明原文出处:Harries Blog™ » Spring Boot使用SpringFox自动生成Api Doc

赞 (0)

分享到:更多 ()

评论 0

  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址