# 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**: 0
- **Forks**: 0
- **Created**: 2025-07-15
- **Last Updated**: 2025-09-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## 介绍
简化springdoc的使用（可以搭配knife4j-openapi3-jakarta-spring-boot-starter一起使用）。当前基于jdk21和springboot3.X，点[此处](https://gitee.com/easy-framework/easy-openapi)访问jdk8和springboot2.X的版本

## maven引用
```xml
<dependency>
    <groupId>io.github.xiaoyudeguang</groupId>
    <artifactId>easy-springdoc</artifactId>
    <version>1.0.3</version>
</dependency>
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-openapi3-jakarta-spring-boot-starter</artifactId>
    <version>${knife4j-openapi3.version}</version>
</dependency>
```
## 在yml中添加配置

```yml
springdoc:
  api-docs:
    enabled: true
  info:
    title: easy-springdoc 示例项目
    description: easy-springdocb 示例项目
    version: ${project.version}
    contact:
      name: 赵光
      email: 1316851612@qq.com
    license:
      name: Apache 2.0
      url: https://www.apache.org/licenses/LICENSE-2.0.html
  groups:
    enabled: true
  group-configs:
    - group: demo
      paths-to-match: /user/**
      display-name: "用户接口"
  paths-to-exclude: /internal/**
  oauth2:
    client-id: oauth-client-id
    client-secret: oauth-client-secret
  cache:
    disabled: false
  writer-with-default-pretty-printer: true
  writer-with-order-by-keys: true
```
## 接口添加文档注解
### 框架内置写法
```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));
    }
}
```


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