Wie SpringBoot eine API-Dokumentation basierend auf Swagger2 erstellt

1. Abhängigkeiten hinzufügen

<!--SpringBoot使用Swagger2构建API文档的依赖-->
    <dependency>
      <groupid>io.springfox</groupid>
      <artifactid>springfox-swagger2</artifactid>
      <version>2.7.0</version>
    </dependency>

    <dependency>
      <groupid>io.springfox</groupid>
      <artifactid>springfox-swagger-ui</artifactid>
      <version>2.7.0</version>
    </dependency>

2. Swagger2-Konfigurationsklasse erstellen

package com.offcn.config;

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.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration//表示该类为一个配置类，相当于spring中的xml配置文件
@EnableSwagger2 //开启在线文档
public class SwaggerConfig {

  //1.声明 api 文档的属性
  private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
        .title("Spring Boot中使用Swagger2构建RESTful APIs")
        .description("优就业")
        .termsOfServiceUrl("http://www.ujiuye.com/")
        .contact("小刘同学")
        .version("1.0")
        .build();
  }

  //配置核心配置信息
  public Docket createRestApi() {
    return new Docket(DocumentationType.SWAGGER_2)
        .apiInfo(apiInfo())
        .select()
        .apis(RequestHandlerSelectors.basePackage("com.offcn.controller"))
        .paths(PathSelectors.any())
        .build();
  }
}

3. Ändern Sie den Controller und fügen Sie Dokumentationskommentare hinzu Implizite Parameter @ ApiImplicitParam-Anmerkung zum Hinzufügen einer Beschreibung zu den Parametern

4. Sehen Sie sich die Swagger2-Dokumentation an

Starten Sie das Projekt neu

Besuchen Sie:http://localhost:8080/swagger-ui.html

Das obige ist der detaillierte Inhalt vonWie SpringBoot eine API-Dokumentation basierend auf Swagger2 erstellt. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!