Spring Boot) Swagger UI

11134 ワード
Swagger ばね起動 テキストリンク

Swagger UI


Springを使用してRest APIを開発した後、クライアント開発者に対してドキュメントの整理と共有を行うたびに、APIを修正するたびにドキュメントを修正して再共有するのは面倒で、実際にはドキュメントの整理から面倒です.
Swaggerを使用すると、APIドキュメントの自動化は単独でドキュメントにまとめる必要がなく、UIで直接APIをテストすることもできるので便利です.
すなわち,サーバに要求されたAPIリストをHTML画面でテストを行うライブラリとして記録することができる.このライブラリはサーバ起動時に@RestController解析APIを読み出してHTMLドキュメントを生成する.

Swager依存項目の追加


Swagerのpomを使います.xmlに次の依存性を追加する必要があります.
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version> 
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>

Swagger設定の追加


Swager UIを使用するには、次の設定クラスを追加します.
package studio.thinkground.aroundhub.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;

@Configuration
@EnableSwagger2
public class SwaggerConfiguration {

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

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Around Hub Open API Test with Swagger")
                .description("설명 부분")
                .version("1.0.0")
                .build();
    }
}
APIの名前、説明、バージョン情報をApiInfo apiInfo()に明記すればよい.

機能


は、以下の画面でAPIを見ることができる.
はまた、要求の方法を理解する.
APIテストにより、応答も理解できます.
参照)
ハブルーム
[boj](s 5)1439反転
一括追加データSqlBulkCopy