Introduction à la méthode d'intégration de SpringBoot avec Swagger (avec code)-javaDidacticiel-php.cn

Introduction à la méthode d'intégration de SpringBoot avec Swagger (avec code)

不言

Libérer： 2019-03-21 10:11:01

avant

3099 Les gens l'ont consulté

Cet article vous présente la méthode d'intégration de Swagger avec SpringBoot (avec du code). Il a une certaine valeur de référence. Les amis dans le besoin peuvent s'y référer.

Qu'est-ce que Swagger

Swagger peut générer une console API interactive que les développeurs peuvent utiliser pour apprendre et essayer rapidement les API
Swagger peut générer des clients Le code du SDK de fin est utilisé pour une mise en œuvre sur une variété de plates-formes différentes
Les fichiers Swagger peuvent être automatiquement générés à partir de commentaires de code sur de nombreuses plates-formes différentes
Swagger a une forte communauté

Importation de dépendances

<!-- Swagger -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.4.0</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.4.0</version>
</dependency>

Copier après la connexion

🎜>

Ajouter une configuration

swagger:
  title: 项目 API
  description: SpringBoot 集成 Swagger 项目 API
  version: 1.0
  terms-of-service-url: http://www.baidu.com/
  base-package: cn.anothertale.springbootshiro  # 这一项指定需要生成 API 的包，一般就是 Controller
  contact:
    name: taohan
    url: http://www.baidu.ccom/
    email: 1289747698@qq.com

Copier après la connexion

Créer une configuration Swagger

package cn.anothertale.springbootshiro.config.swagger;

import lombok.Getter;
import lombok.Setter;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * description: swagger 配置中心
 *
 * @author: taohan
 * @date: 2019年03月20日
 * @time: 16:52
 */
@Getter
@Setter
@Configuration
@EnableSwagger2
@ConditionalOnClass(EnableSwagger2.class)
@ConfigurationProperties(prefix = "swagger")
public class SwaggerConfig {

    /**
     * API 接口包路径
     */
    private String basePackage;

    /**
     * API 页面标题
     */
    private String title;

    /**
     * API 描述
     */
    private String description;

    /**
     * 服务条款地址
     */
    private String termsOfServiceUrl;

    /**
     * 版本号
     */
    private String version;

    /**
     * 联系人
     */
    private Contact contact;

    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage(basePackage))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title(title)
                .description(description)
                .termsOfServiceUrl(termsOfServiceUrl)
                .version(version)
                .contact(contact)
                .build();
    }
}

Copier après la connexion

Indiquer l'API via annotations

Swagger analyse toutes les interfaces et génère la description de l'API correspondante et les informations sur les paramètres en fonction du package configuré par défaut.

Les annotations couramment utilisées et les attributs correspondants sont les suivants :

@Api
(décrit une classe API et est marqué sur le contrôleur)
1. value :
2. balises :
3. description :
4. basePath :
5. produit :
6. consomme :
7. autorisations :
8. masqué :
  S'il faut masquer dans le document
@ApiOperation
(utilisé dans la méthode Controller, illustre la fonction de la méthode)
1. valeur :
2. tags :
3. description :
4. basePath :
5. position :
6. response :
7. responseContainer :
8. httpMethod :
9. code :
10. extensions :
  Propriétés de l'extension
@ApiImplicitParams
(utilisé sur les méthodes Controller, décrivant un ensemble de paramètres de requête)
1. value :
  ApiImplicitParam tableau, voir la note suivante
@ApiImplicitParam
(Décrit un paramètre de requête)
1. nom :
2. valeur :
3. defaultValue :
4. obligatoire :
5. accès :
6. exemple :
  Exemple
@ApiResponses
(description Un ensemble de réponses)
1. valeur :
  ApiResponse tableau, voir la note suivante
@ApiResponse
(Décrivez une réponse)
1. code :
2. message :

Introduction à la méthode dintégration de SpringBoot avec Swagger (avec code) Enfin, vous pouvez saisir http:/ /localhost:8080/swagger-ui.html dans le navigateur pour y accéder !