Chinaunix首页 | 论坛 | 博客
  • 博客访问: 549072
  • 博文数量: 298
  • 博客积分: 0
  • 博客等级: 民兵
  • 技术积分: 3077
  • 用 户 组: 普通用户
  • 注册时间: 2019-06-17 10:57
文章分类

全部博文(298)

文章存档

2022年(96)

2021年(201)

2019年(1)

我的朋友

分类: Java

2022-03-29 09:48:02


点击(此处)折叠或打开


  1. 简介
  2. ??Lkadoc是一款开源的接口文档自动生成工具,基于SpringBoot平台,拥有非常强大的接口文档管理功能。为解决Java后台开发人员编写接口文档、调试接口而生。同时提供了简洁、大气、功能丰富的接口文档UI操作界面,方便后端与前端之间的接口对接。

  3. 愿景

  4. ??我们愿成为java开发人员最好的基友,从手动编写接口文档的痛苦中解救出来,丢弃难用的Postman,工作效率从此翻倍,不再加班,有更多的时间陪伴家人。

  5. pom.xml文件中引入lkadoc的依赖

  6. <!--Lkadoc包-->
  7. <dependency>
  8.     <groupId>com.github.liukaitydn</groupId>
  9.     <artifactId>lkadoc-api</artifactId>
  10.     <version>1.4.0</version>
  11. </dependency>
  12. <dependency>
  13.     <groupId>com.github.liukaitydn</groupId>
  14.     <artifactId>lkadoc-annotations</artifactId>
  15.     <version>1.4.0</version>
  16. </dependency>
  17. 在LkadocDemo项目启动类LkadocDemoApplication上加上@LKADocument注解

  18. /**
  19.  * 说明:启动类
  20.  * 作者:FH Admin
  21.  * from:fhadmin.cn
  22.  */
  23. @LKADocument(basePackages="org.fh.controller")
  24. @SpringBootApplication
  25. public class LkadocDemoApplication {
  26.     public static void main(String[] args) {
  27.         SpringApplication.run(LkadocDemoApplication.class, args);
  28.     }
  29. }
  30. 在org.fh.controller包下面准备一个用户登录注册模块类-LKADemoController

  31. /**
  32.  * 说明:用户登录注册
  33.  * 作者:FH Admin
  34.  * from:fhadmin.cn
  35.  */
  36. @LKAType(value="用户登录注册模块")
  37. @RestController
  38. @RequestMapping("user")
  39. public class LKADemoController {
  40.  
  41.     @LKAMethod(value="登录")
  42.     @LKAParam(names= {"name","pwd"},values= {"用户名","密码"})
  43.     @LKARespose(names= {"code","msg"},values= {"状态码","消息"})
  44.     @PostMapping("login")
  45.     public Map<String,Object> login(String name, String pwd) {
  46.         Map<String,Object> map = new HashMap<>();
  47.         map.put("code",200);
  48.         map.put("msg","登录成功,欢迎"+name+"光临本系统");
  49.         return map;
  50.     }
  51. }

  52. 启动项目,打开浏览器,输入地址 http://127.0.0.1:8080/lkadoc.html


阅读(537) | 评论(0) | 转发(0) |
给主人留下些什么吧!~~