简介
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;
}
}
相关推荐
springboot整合swagger构建Api文档,对于整理在线文档这是一大利器,相对于ssm整合是真的简单方便,不管是不是新手,一看就能懂,对于与前端交互,那是相当的便捷。
springboot整合 netty做心跳检测 springboot整合 netty做心跳检测 springboot整合 netty做心跳检测 springboot整合 netty做心跳检测 springboot整合 netty做心跳检测 springboot整合 netty做心跳检测 springboot整合...
主要介绍了SpringBoot整合Swagger3生成接口文档过程解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
SpringBoot结合Swagger自动生成api文档.docx
SpringBoot整合actable,根据实体自动反向生成数据库表,方法简洁明了,省去手动创建数据库表的麻烦。 运行环境 jdk8+mysql5.7+IntelliJ IDEA+maven 项目技术(必填) spring boot+mybatis 数据库文件(可选) ...
springboot整合Swagger2实现API接口,代码一键可用。
API文档
springboot整合redis.算是比较全面的一种整合方式了. springboot整合redis.算是比较全面的一种整合方式了.
springboot整合thymeleaf模板
springboot整合freemarker生成静态html的demo 主要讲解了通过模板生成html和通过字符串生成html
springboot 整合swagger2.0支持API注释显示 springboot 整合swagger2.0支持API注释显示 springboot 整合swagger2.0支持API注释显示
根据业务需求需要,需要将json格式的api信息【比如postman导出接口文档这类的】,导出成标准接口文档的word文件。 该平台是将一些好的第三方平台接口接入进来,供用户使用,每个用户下有可以使用的接口,可以根据...
springboot整合CXF发布webservice和客户端调用 项目中每个类都有详细的注释,保证都能看懂,不失为一个学习springboot整合cxf来学习webservice发布调用的好例子
项目概述:这是一个基于SpringBoot的数据库文档自动生成工具,旨在通过简单的配置,快速生成详尽的数据库文档。该项目采用Java语言开发,包含39个文件,其中Java源文件22个,辅助以HTML、图像资源以及配置文件等。 ...
cxf整合springboot项目开发文档实例cxf整合springboot项目开发文档实例cxf整合springboot项目开发文档实例
SpringBoot整合Shiro示例实现动态权限加载更新+Session共享+单点登录 SpringBoot整合Shiro示例实现动态权限加载更新+Session共享+单点登录 SpringBoot整合Shiro示例实现动态权限加载更新+Session共享+单点登录 ...
Springboot快速搭建跨域API接口(idea社区版2023.1.4+apache-maven-3.9.3-bin) 初学java的孩子们建议好好看看,整个配置包含示例代码都是最最完整的,而且我在文末还准备了对应的项目压缩包,绝对可以让你复现的哦
SpringBoot整合neo4j案例源码
springboot整合stream使用rabbitmq作为消息中间件
基于springboot+jpa实现java后台api接口,点餐系统 基于springboot+jpa实现java后台api接口,点餐系统 基于springboot+jpa实现java后台api接口,点餐系统 基于springboot+jpa实现java后台api接口,点餐系统 基于...