Wie Springboot Springdoc integriert

Schritte für Springboot zur Integration von Springdoc: 2. Konfigurationsdatei; 4. DTO-Klasse erstellen; 6. Starten Sie die Anwendung und greifen Sie auf die API-Dokumentationsseite zu . Detaillierte Einführung: 1. Abhängigkeiten hinzufügen, Springdoc-Abhängigkeiten in der pom.xml-Datei des Spring Boot-Projekts hinzufügen 2. Konfigurationsdateien im Spring Boot-Projekt usw.

Das Betriebssystem dieses Tutorials: Windows 10-System, DELL G3-Computer.

Um Spring Boot und Springdoc zu integrieren, können Sie die folgenden Schritte ausführen:

1. Abhängigkeiten hinzufügen

In der pom.xml-Datei Ihres Spring Boot-Projekts fügen Sie die Abhängigkeit von Springdoc hinzu. Das Folgende ist ein Beispiel:

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

2. Konfigurationsdatei

Fügen Sie in der application.yml-Datei Ihres Spring Boot-Projekts die folgende Konfiguration hinzu:

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

3. Konfigurieren Sie die Swagger3Config-Klasse

Erstellen Sie eine Swagger3Config Klasse und implementieren Sie die OpenAPISchemaConverter-Schnittstelle. Diese Klasse wird verwendet, um verwandte Parameter von Swagger3 zu konfigurieren. Das Folgende ist ein Beispiel:

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

4. Erstellen Sie eine DTO-Klasse

Erstellen Sie eine DTO-Klasse (Data Transfer Object), um das Modell von API-Anfragen und -Antworten zu definieren. Verwenden Sie Swagger-Anmerkungen, um Modellfelder und -typen zu beschreiben. Das Folgende ist ein Beispiel:

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

5. Erstellen Sie API-Schnittstellen und Annotationen

Erstellen Sie in Ihrer Service- oder Controller-Schicht API-Schnittstellen und Annotationen und verwenden Sie Swagger-Annotationen, um den API-Pfad, die Anforderungsmethode, Parameter usw. zu beschreiben . Information. Hier ist ein Beispiel:

@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. Starten Sie die Anwendung und greifen Sie auf die API-Dokumentationsseite zu.

Starten Sie Ihre Spring Boot-Anwendung und geben Sie die Zugriffsadresse der Anwendung in den Browser ein. Sie sollten die Swagger-Benutzeroberfläche sehen können, die Ihre API-Dokumentation und verfügbare API-Schnittstellen enthält.

Das obige ist der detaillierte Inhalt vonWie Springboot Springdoc integriert. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!