之前我有提过文档的事,标题是《文档!文档!文档!重要的事情说三遍!》,其中提到的文档工具是使用wiki来管理文档,当然也能配合jira来分发任务,以及管理bug,查看每个任务的工作流状态等等
今天来讲讲另外一个文档工具,swagger spring,这个插件比较好用,非常适合那种敏捷开发的小团队,不像wiki那么繁琐,更没有word或者excel那么难以管理,使用这个工具,你只需要在代码中配置好相应的注解,在spring容器加载的时候就自动扫描进去了,使用非常方便,那么先来简单看看吧
首先需要配置pom,引入相应的jar包
配置好SwaggerConfig这个类,内容如下:
然后你要去github上找到这个项目,然后下载后吧dlist中的所有内容导入到自己的项目中,在index.html中修改路径,
http://petstore.swagger.io/v2/swagger.json";
这个是加载json,需要把这个段替换为你自己的地址:"http://localhost:8080/swagger-ui.html"
最后访问你就会得到对应的界面了
好了,OK,十分简单的配置,但是绝提的接口对于参数等等,自己看api吧,十分简单,非常适合小团队开发
最后说一点,需要注意的事如果你的接口都配置好了拦截器,那么你需要做一下相应的处理,才能显示文档ui界面。
另外图片中的代码由于微信不支持所以截图,如果需要代码可以去我的博客复制。