springboot가 springdoc를 통합하는 방법

springboot가 springdoc을 통합하는 단계: 1. 종속성 추가 2. 구성 파일 3. Swagger3Config 클래스 구성 4. API 인터페이스 및 주석 생성 6. 애플리케이션 시작 및 API 문서 페이지에 액세스 . 자세한 소개: 1. 종속성을 추가하고, Spring Boot 프로젝트의 pom.xml 파일에 Springdoc 종속성을 추가합니다. 2. Spring Boot 프로젝트에 구성 파일을 추가합니다.

이 튜토리얼의 운영 체제: Windows 10 시스템, DELL G3 컴퓨터.

Spring Boot와 Springdoc를 통합하려면 다음 단계를 따르세요.

1. 종속성 추가

Spring Boot 프로젝트의 pom.xml 파일에 Springdoc의 종속성을 추가합니다. 다음은 예시입니다.

<dependency>  
    <groupId>org.springdoc</groupId>  
    <artifactId>springdoc-openapi-ui</artifactId>  
    <version>1.5.3</version>  
</dependency>

2. 구성 파일

Spring Boot 프로젝트의 application.yml 파일에 다음 구성을 추가합니다.

springdoc:  
  api-docs:  
    enabled: true # 开启文档功能，默认为true，可不配置  
  swagger-ui:  
    path: /api # 访问路径，默认为/swagger-ui.html

3 Swagger3Config 클래스 구성

Swagger3Config 만들기 클래스, 그리고 OpenAPISchemaConverter 인터페이스를 구현합니다. 이 클래스는 Swagger3의 관련 매개변수를 구성하는 데 사용됩니다. 다음은 예입니다.

@Configuration  
public class Swagger3Config {  
    @Bean  
    public OpenAPISchemaConverter openAPISchemaConverter() {  
        return new OpenAPISchemaConverter();  
    }  
}

4. DTO 클래스 만들기

API 요청 및 응답 모델을 정의하는 DTO(데이터 전송 개체) 클래스를 만듭니다. Swagger 주석을 사용하여 모델 필드 및 유형을 설명합니다. 다음은 예입니다.

@ApiModel(description = "用户模型")  
public class UserDTO {  
    @ApiModelProperty(notes = "用户ID", required = true)  
    private Long id;  
    @ApiModelProperty(notes = "用户姓名", required = true)  
    private String name;  
    // 其他字段和注解...  
}

5. API 인터페이스 및 주석 생성

서비스 계층 또는 컨트롤러 계층에서 API 인터페이스 및 주석을 생성하고 Swagger 주석을 사용하여 API 경로, 요청 방법, 매개변수 등을 설명합니다. . 정보. 예는 다음과 같습니다.

@RestController  
@RequestMapping("/api")  
public class UserController {  
    @ApiOperation(value = "获取用户信息", notes = "根据ID获取用户信息")  
    @ApiImplicitParams({@ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long")})  
    @GetMapping("/user/{id}")  
    public ResponseEntity<UserDTO> getUserById(@PathVariable Long id) {  
        // 实现获取用户信息的逻辑...  
    }  
}

6 애플리케이션을 시작하고 API 문서 페이지에 액세스합니다.

Spring Boot 애플리케이션을 시작하고 브라우저에 애플리케이션의 액세스 주소를 입력합니다. API 문서와 사용 가능한 API 인터페이스가 포함된 Swagger UI 인터페이스를 볼 수 있어야 합니다.

위 내용은 springboot가 springdoc를 통합하는 방법의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!