一种基于微服务框架的接口文档自动生成方法及工具

摘要

本发明公开一种基于微服务框架的接口文档自动生成方法及工具，涉及前后端开发技术领域，采用技术方案基于微服务框架，通过配置文档生成配置类、在pom.xml中配置离线文档参数、对实体bean及controller的层进行代码注解、对接口进行单端测试并最终自动生成接口文档，解决了前后端分离情况下前端人员仍需要了解后端的接口及数据格式而导致的开发效率低的问题，可满足于微服务框架前后端分离的开发模式对于接口文档的需求，既可以减少开发人员创建文档的工作量，同时将说明内容整合到实现代码中，让维护文档和修改代码整合为一体，在节省开发时间的同时，还能提高开发效率。