创建API的人通常不是使用API的人. 最受欢迎的API 文档生成工具就是Swagger.可以将源数据转换成一个很好的基于Html的文档. 可以将API用做REST的客户端.
手动编写此类文档, 并在代码里更改, 实现并不方便. 所以SpringFox可以在此发挥优势.它可以自动检查你的类, 检测你的控制器, 模型的类, 以及映射的URL, 没有任何手写的文档, 只需要检查应用程序中的类. 最重要的是每当进行更改时, 都会自动更新到文档当中.
如何做到快速集成?
Springfox Release的当前最新版本: https://github.com/springfox/springfox/releases
项目源代码: https://github.com/vojtechruz/rest-docs-starter
1. 如何开始:
-> 从git hub下载示例代码: https://github.com/vojtechruz/rest-docs-starter
https://github.com/vojtechruz/springfox-example
2. 打开Eclipse(支持Maven),Import这两个项目.用Maven编译.
->Tips: 编译springfox-example的时候, 你可能会遇到"Archive for required library: .... guava 2.0.jar annot be read or is not a valid ZIP file"
解决方法: 从Maven上手动下载一个新的guava-20.0.jar, 覆盖本地\.m2\repository\com\google\guava\guava\20.0\下的原文件. 重新运行maven.