Comment Springboot intègre Springdoc

Étapes pour que Springboot intègre Springdoc : 1. Ajouter des dépendances ; 2. Fichier de configuration ; 3. Configurer la classe Swagger3Config ; 4. Créer une interface API et des annotations ; . Introduction détaillée : 1. Ajouter des dépendances, ajouter des dépendances Springdoc dans le fichier pom.xml du projet Spring Boot 2. Fichiers de configuration, dans le projet Spring Boot, etc.

Le système d'exploitation de ce tutoriel : système Windows 10, ordinateur DELL G3.

Pour intégrer Spring Boot et Springdoc, vous pouvez suivre les étapes ci-dessous :

1. Ajouter des dépendances

Dans le fichier pom.xml de votre projet Spring Boot, ajoutez la dépendance de Springdoc. Voici un exemple :

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

2. Fichier de configuration

Dans le fichier application.yml de votre projet Spring Boot, ajoutez la configuration suivante :

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

3. Configurez la classe Swagger3Config

Créez un Swagger3Config. classe, Et implémenter l'interface OpenAPISchemaConverter. Cette classe est utilisée pour configurer les paramètres associés de Swagger3. Voici un exemple :

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

4. Créez une classe DTO

Créez une classe DTO (Data Transfer Object) pour définir le modèle de requêtes et de réponses API. Utilisez les annotations Swagger pour décrire les champs et les types de modèles. Voici un exemple :

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

5. Créez des interfaces et des annotations API

Dans votre couche de service ou couche de contrôleur, créez des interfaces et des annotations API et utilisez les annotations Swagger pour décrire le chemin de l'API, la méthode de requête, les paramètres, etc. . information. Voici un exemple :

@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. Démarrez l'application et accédez à la page de documentation de l'API

Démarrez votre application Spring Boot et saisissez l'adresse d'accès de l'application dans le navigateur. Vous devriez pouvoir voir l'interface Swagger UI, qui contient la documentation de votre API et les interfaces API disponibles.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!