[JAVA] Spring Fox ① Introduction

Spring Fox ① Introduction

Qu'est-ce que Spring Fox?

Lorsqu'il est utilisé en combinaison avec le framework Spring, il génère automatiquement des documents API pour le système cible.

• En interne, ** Swagger ** décrit plus loin est utilisé.

De plus, il est possible de supprimer les ** erreurs humaines ** et de créer des documents avec ** uniformité ** en ** générant automatiquement ** à partir du système.

Qu'est-ce que Swagger

Puisqu'il y a beaucoup de points, c'est un bulletin ... φ (...)

• Géré par un fichier de définition appelé Swagger Spec

• Défini en JSON ou YAML

• Documents d'interface utilisateur Swagger basés sur Swagger Spec

• Les documents générés peuvent être personnalisés en fonction du HTML et de jQuery

• Prend en charge les cadres dans différentes langues

• Il est également possible de créer comme r en utilisant Swagger core sans créer Swagger Spec

• Il existe d'autres outils tels que Swagger Editor, Swagger Codegen et Swagger Node (apparemment).

• Des outils externes tels que Postman et Amazon API Gateway sont également pris en charge.

• Swagger Test Template génère et exécute automatiquement le code de test JavaScript à partir d'un fichier Spec.

• Swagger est adopté par «Open API Initiative», une organisation qui promeut des formats standard pour décrire les interfaces API RESTful.

• ** Le plan de l'API ** est connu comme un autre outil de génération de documents API.

introduction

1. Ajouter une dépendance

Ajouté aux dépendances de gradle

build.gradle

dependencies {
...
  compile "io.springfox:springfox-swagger2:2.2.2"
  compile "io.springfox:springfox-swagger-ui:2.2.2"
  compile "com.google.guava:guava:17.0"
...
}

2. Activez Spring Fox

Ajouter et activer des annotations

Application.java

@SpringBootApplication
@EnableSwagger2//ajouter à
public class Application extends SpringBootServletInitializer
{
    public static void main( String... args )
    {
         SpringApplication.run( Application.class, args );
    }
}

3. Ajoutez JavaConfig pour la documentation

SwaggerConfiguration.java

@Configuration
public class SwaggerConfiguration
{
    @Bean
    public Docket publicDocument()
    {
        return new Docket( DocumentationType.SWAGGER_2 ).groupName( "public" )
                .select()
                .paths( paths() )
                .build()
                .apiInfo( apiInfo() );
    }
    
    private ApiInfo apiInfo()
    {
        ApiInfo apiInfo = new ApiInfo(
                "My REST API",
                "Some custom description of API.",
                "API TOS",
                "Terms of service",
                "[email protected]",
                "License of API",
                "API license URL");
        return apiInfo;
    }
    
    private Predicate<String> paths() {
        return or(
           regex("/some/endpoint")
        );
    }
    
}

4. Contrôle de fonctionnement

Accédez à /swagger-ui.html

• Les points de terminaison sont ajoutés automatiquement.

C'est pratique car la classe Java de la valeur de retour est automatiquement convertie en JSON SCHEMA et vous pouvez faire une requête à partir de cet écran.

la prochaine fois

prochain

--Comment ajouter des paramètres d'en-tête --Pull-down en utilisant la valeur DB

• Documentation statique

Je vais y toucher.

Eh bien.