# easy-springdoc

**Repository Path**: easy-framework/easy-springdoc

## Basic Information

- **Project Name**: easy-springdoc
- **Description**: 简化springdoc的使用（可以搭配knife4j-openapi3-jakarta-spring-boot-starter一起使用）
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2025-07-15
- **Last Updated**: 2025-11-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 介绍
springboot项目接口文档管理工具（可以作为knife4j的平替）

## maven引用
```xml
<dependency>
    <groupId>io.github.xiaoyudeguang</groupId>
    <artifactId>easy-springdoc</artifactId>
    <version>1.0.6</version>
</dependency>
```
# 使用说明

## 1.在yml中添加配置

```yml
springdoc:
  api-docs:
    enabled: true
  openapi:
    info:
      title: @project.artifactId@
      description: @project.description@
      version: @project.version@
      contact:
        name: 张三,李四
quick-login:
  permission:
    - userNo: zhangsan #用户编码
      userName: 张三 #用户名
      password: 123456 #密码
      avatar: http://www.baidu.com #头像地址
      mobile: 17696078138 #手机号
      role: admin,roleManage #角色
```

## 2.访问链接：http://127.0.0.1:8080/docx.html

![输入图片说明](image1.png)
![输入图片说明](image2.png)

## 3.接口添加文档注解
### 框架内置写法
```java
import com.example.model.SysUser;
import com.example.service.UserService;
import com.xiaoyudeguang.annotations.RequestMapping;
import com.xiaoyudeguang.annotations.RestController;
import io.swagger.v3.oas.annotations.Parameter;
import org.springframework.web.bind.annotation.RequestParam;

@RestController(value = "/user", tags = "用户接口", author = "赵光")
public class UserController {

    @Autowired
    private SysUserService sysUserService;

    @RequestMapping(value = "/getUserByUserNo", summary = "根据用户编码查询用户")
    public BaseResult<SysUser> getUserByUserNo(@RequestParam(value = "userNo") @Parameter(description = "用户编码") String userNo) {
        return BaseResult.ok(sysUserService.getOne(SysUser::getUserNo, userNo));
    }
}
```
### 原生写法

```java
import com.example.model.SysUser;
import com.example.service.UserService;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.tags.Tag;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@Tag(name = "用户接口")
@RestController
@RequestMapping(value = "/user")
public class UserController {

    @Autowired
    private SysUserService sysUserService;

    @Operation(summary = "根据用户编码查询用户")
    @RequestMapping(value = "/getUserByUserNo")
    public BaseResult<SysUser> getUserByUserNo(@RequestParam(value = "userNo") @Parameter(description = "用户编码") String userNo) {
        return BaseResult.ok(sysUserService.getOne(SysUser::getUserNo, userNo));
    }
}
```

## 4.需要登录功能的同学请参考[quick-login](https://gitee.com/quick-data/quick-login)的使用教程