成都网站网络建设,免费的行情网站app,天津网站建设中心,多个网站给一个网站推广JApiDocs是一个无需额外注解、开箱即用的SpringBoot接口文档生成工具。编写和维护API文档这个事情#xff0c;对于后端程序员来说#xff0c;是一件恼人但又不得不做的事情#xff0c;我们都不喜欢写文档#xff0c;但除非项目前后端代码都是自己写的#xff0c;否则API文… JApiDocs是一个无需额外注解、开箱即用的SpringBoot接口文档生成工具。编写和维护API文档这个事情对于后端程序员来说是一件恼人但又不得不做的事情我们都不喜欢写文档但除非项目前后端代码都是自己写的否则API文档将是前后端协作中一个不可或缺的沟通界面。既然不可避免那就想办法弄个轮子吧。人生苦短必须偷懒。无图无真相生成文档的效果如下相比Swagger要写一堆注解Spring RestDocs需要写测试用例才能生成API文档。JApiDocs 具有无痛集成的特点你只需花几分钟就能知道它怎么用了。快速开始要使得JApiDcos正确工作你写的代码应该是像下面的样子的/** * 用户接口 */RequestMapping(/api/user/)RestControllerpublic class UserController {/** * 用户列表 * param listForm */RequestMapping(path list, method {RequestMethod.GET, RequestMethod.POST} )public ApiResult list(UserListForm listForm){return null; }/** * 保存用户 * param userForm */PostMapping(path save)public ApiResult saveUser(RequestBody UserForm userForm){return null; }}我们给Controller类和方法加上必要的注释给接口方法返回相关的对象类型。是的这样JApiDocs就能解析到相关的接口信息了就跟我们平时写的代码是差不多的但要注意你要通过param来告诉JApiDocs接口的参数但在IDE的帮助下这个工作将是轻松愉悦的然后你在任意一个main入口方法执行下面的代码就可以生成文档了DocsConfig config new DocsConfig();config.setProjectPath(your springboot project path); // 项目根目录config.setProjectName(ProjectName); // 项目名称config.setApiVersion(V1.0); // 声明该API的版本config.setDocsPath(your api docs path); // 生成API 文档所在目录config.setAutoGenerate(Boolean.TRUE); // 配置自动生成Docs.buildHtmlDocs(config); // 执行生成文档接下来你只管好好写代码生成Api文档的工作就可以交给JApiDocs了你不需要再为额外编写和维护文档而烦恼。功能特性1、代码即文档JApiDocs是通过直接解析SpringBoot的源码语法来工作的所以只要Controller的语法符合一定的代码规范有合理的注释就可以直接导出文档。2、支持导出HTML便捷的导航和接口查看界面可本地预览或者部署到HTTP服务器。推荐部署到服务器方便前后端展开协作。3、同步导出客户端Model代码支持导出Android端的 Java 和iOS端的 Object C Model代码减少前端程序员的重复编码工作。4、更多特性支持接口搜索支持不同版本和英文文档自定义扩展等。简洁的文档再好用的东西如果没有文档说明别人也无从入手。为了让大家尽快上手JApiDocs准备了一份极简的文档说明确保你在几分钟就能用上JApiDocs。花5分钟不到就能认识一个提高工作效率的工具让你把更多的时间花在更加有价值的事情上你确认不看一下吗“仓库地址https://github.com/YeDaxia/JApiDocs“中文文档https://japidocs.agilestudio.cn/#/zh-cn/
