Java開発ドキュメントSwaggerの使用詳細チュートリアル

Springbootにswaggerを追加する
バージョン2.7.0
バージョン2.8.0
UIインタフェースを使うのは違いますが、個人的には2.7.0が好きです.
1.swagger依存のインポート

    io.springfox
    springfox-swagger2
    2.8.0


    io.springfox
    springfox-swagger-ui
    2.8.0

2.SwaggerConfig構成クラスの作成

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
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.swagger.web.UiConfiguration;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 *
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {

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

    private ApiInfo buildApiInf() {
        return new ApiInfoBuilder()
                .title("      ")
                .description("Zuul+Swagger2  RESTful APIs")
                .version("1.0")
                .build();
    }
}

 
 3.注釈の使用

@Api：     ，  Controller   
@ApiOperation：          ，       
@ApiParam：      
@ApiModel：        
@ApiProperty：        ，         
@ApiResponse：HTTP    1   
@ApiResponses：HTTP      
@ApiIgnore：         API
@ApiError ：         
@ApiImplicitParam：      
@ApiImplicitParams：