之前公司 API 文档混乱不堪,维护困难,我推荐了 Swagger,希望能采用 Open API 规范来写文档。
但是技术经理也没分清楚,他找到了 Springfox 那个工具,可以在 Spring 项目中生成 API 文档。
我司最近的新 SpringBoot 项目,技术经理让我把这个东西配置上。
然后我就开始做这个事了。看下官网的 Reference 就开始了。
现在我用这个工具,感觉非常反常规操作。
配置的地方有预期的想法,但是没有生效。也不知道怎么查怎么回事。
没有细粒度的排除,导致输出的 API 文档多了很多东西
Security 方面,也没有找到 Http Method 的匹配,只找到了 path 的匹配。单独配置 @ApiKeyAuth。。。那个注解也没有生效,不知道去哪找原因
官网也没有输出一个包含注释的 doc 文档。javadoc,虽然代码里面有注释。
这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。
V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。
V2EX is a community of developers, designers and creative people.