Sprigboot統合swager 2

10653 ワード

Sprigboot統合swager 2
山西省の公式サイト
swagger 2公式サイト:https://swagger.io/
璣璖maven住所
sprigfox-swager 2:http://mvnrepository.com/artifact/io.springfox/springfox-swagger2
sprigfox-swager-ui:http://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui
pom.xmlに依存を追加

<dependency>
    <groupId>io.springfoxgroupId>
    <artifactId>springfox-swagger2artifactId>
    <version>2.9.2version>
dependency>
<dependency>
    <groupId>io.springfoxgroupId>
    <artifactId>springfox-swagger-uiartifactId>
    <version>2.9.2version>
dependency>

swagger 2配置類を作成します。
package top.simba1949.config;

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

/**
 * Swagger2    
 * @Configuration   Spring         
 * @EnableSwagger2      swagger2
 * @author [email protected]
 * @date 2018/7/4 21:36
 */
@Configuration
@EnableSwagger2
public class Swagger2 {
    /**
     * swagger2    ,  createRestApi    Docket Bean,
     * apiInfo()      Api     (               )。
     * select()       ApiSelectorBuilder             Swagger   ,
     *                ,Swagger        Controller   API,       (   @ApiIgnore     )。
     * @return
     */
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("top.simba1949.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Spring Boot   Swagger2  RESTful APIs")
                .description("  ")
                .termsOfServiceUrl("http://localhost:8888/")
                .version("1.0")
                .build();
    }

}
プロジェクトを実行すればいいです
テストアクセス:http://localhost:8888/swagger-ui.
Springboot集成swagger2_第1张图片