20200213 - 闊歩紹介

OpenAPIの仕様は、（OpenAPISpeci Fiのカチオンは、OASをいう。）、RESTfulなサービスの開発プロセスを調整するために、APIまたはAPIは、言語を定義する記述するために使用される形式を定義しようとする試みLinux Foundationのプロジェクトで、現在のバージョンがリリースされましたV3.0、およびオープンソースでありますgithubの上。（Https://github.com/OAI/OpenAPI-Speci Fiの陽イオン）闊歩は世界最大のOpenAPIの仕様設計からテストし、展開、およびAPI全体のライフサイクルのドキュメントに開発をサポート（OAS）API開発ツールのフレームワークです。（Https://swagger.io/）

次のAPIプロジェクトで

package com.xuecheng.api.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 Swagger2Configuration {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.xuecheng"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("学成网api文档")
                .description("学成网api文档")
//                .termsOfServiceUrl("/")
                .version("1.0")
                .build();
    }

}

上記のコメントがあり、@EnableSwagger2あなたが持っているすべてスキャンします@RestControllerコントローラクラスを

URLを以下のポートを開く

ポイントが見てテストすることができます

が、我々は情報を使用するかわからない、またはあなたが書くコードの時にコメントで表現するために必要なものとして、

、クラス全体を変更@ApiOperationコントローラの役割を説明した：@Apiを：闊歩が闊歩インターフェイスを生成するJavaクラスにアノテーションを追加し、共通闊歩は次の通り注釈付きクラスまたはインタフェース@ApiParamの方法が記載されて：単一のパラメータ説明@ApiModel：パラメータ@ApiModelPropertyでオブジェクトを受信：オブジェクトパラメータを受信すると、オブジェクトのフィールドの記述は@ApiResponse：HTTPレスポンス全体説明@ApiIgnore：HTTPレスポンスを前記@ApiResponses記載されてApiError次@ APIを使用して注釈を無視します。 @ApiImplicitParamエラー情報が返される。@ApiImplicitParamsパラメータ要求：要求複数のパラメータを