简介
Lkadoc是一款开源的接口文档自动生成工具，基于SpringBoot平台，拥有非常强大的接口文档管理功能。为解决Java后台开发人员编写接口文档、调试接口而生。同时提供了简洁、大气、功能丰富的接口文档UI操作界面，方便后端与前端之间的接口对接。
愿景
我们愿成为java开发人员最好的基友，从手动编写接口文档的痛苦中解救出来，丢弃难用的Postman，工作效率从此翻倍，不再加班，有更多的时间陪伴家人。
pom.xml文件中引入lkadoc的依赖
<!--Lkadoc包--> <dependency> <groupId>com.github.liukaitydn</groupId> <artifactId>lkadoc-api</artifactId> <version>1.4.0</version> </dependency> <dependency> <groupId>com.github.liukaitydn</groupId> <artifactId>lkadoc-annotations</artifactId> <version>1.4.0</version> </dependency>
在LkadocDemo项目启动类LkadocDemoApplication上加上@LKADocument注解
/** * 说明：启动类 * 作者：FH Admin * from：fhadmin.cn */ @LKADocument(basePackages="org.fh.controller") @SpringBootApplication public class LkadocDemoApplication { public static void main(String[] args) { SpringApplication.run(LkadocDemoApplication.class, args); } }
在org.fh.controller包下面准备一个用户登录注册模块类-LKADemoController
/** * 说明：用户登录注册 * 作者：FH Admin * from：fhadmin.cn */ @LKAType(value="用户登录注册模块") @RestController @RequestMapping("user") public class LKADemoController { @LKAMethod(value="登录") @LKAParam(names= {"name","pwd"},values= {"用户名","密码"}) @LKARespose(names= {"code","msg"},values= {"状态码","消息"}) @PostMapping("login") public Map<String,Object> login(String name, String pwd) { Map<String,Object> map = new HashMap<>(); map.put("code",200); map.put("msg","登录成功，欢迎"+name+"光临本系统"); return map; } }
