[JAVA] Créez des spécifications API intéressantes avec Micronaut + Swagger UI

1. Ajouter une dépendance </ b>

build.gradle


dependencies {
    annotationProcessor "io.micronaut.configuration:micronaut-openapi" 
    implementation "io.swagger.core.v3:swagger-annotations" 
}

Un fichier yaml conforme aux spécifications OpenAPI sera généré au moment de la construction. Pour les annotations qui peuvent être utilisées, reportez-vous au Wiki de Swagger. https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Annotations

Si vous souhaitez le gérer en tant que contenu statique, ajoutez ce qui suit à application.yml. Vous pouvez gérer le fichier HTML généré décrit plus loin dans la même procédure.

application.yml


micronaut:
    router:
        static-resources:
            swagger:
                paths: classpath:META-INF/swagger
                mapping: /swagger/**

Manipulation du contenu statique Voir le manuel Micronaut pour plus de détails https://docs.micronaut.io/1.1.0/guide/index.html#staticResources

2. Rendez-le bon en HTML à partir du fichier yaml </ b> Utilisez l'interface utilisateur Swagger. Si vous voulez un style de type Swagger UI, copiez simplement le fichier entier sous / dist à https://github.com/swagger-api/swagger-ui. Le reste est dans index.html

index.html


url: "https://petstore.swagger.io/v2/swagger.json"

Réécrivez simplement ceci dans l'URL du fichier yml.

Au fait, si vous pensez ne pas trouver @ApiModel ou @ApiModelProperty, il semble que toutes les annotations de définition de schéma ont été intégrées dans @Schema. http://docs.swagger.io/swagger-core/v2.1.1/apidocs/io/swagger/v3/oas/annotations/media/Schema.html

Recommended Posts