SpringBootプロジェクト構成swagger 2
1842 ワード
最初のステップはpomです.xmlファイルに依存を追加
ステップ2 configフォルダの下にコンフィギュレーションクラスを作成します.SwaggerConfigコードと名前を付けます.
@Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket api() { return new Docket(DocumentationType.SWAGGER_2) .select() .apis(RequestHandlerSelectors.basePackage("*******.controller")) .paths(PathSelectors.any()) .build() .apiInfo(apiInfo()); } private ApiInfo apiInfo(){return new ApiInfoBuilder().title("テストAPI").description("テストインタフェースの説明").version("1.0").build();
}说明:.basePackageにあなたのcontrollerがいるフォルダの位置を記入します.
第3歩springbootプロファイルにプロファイルを追加するここで使用するのは.ymlファイル(階層関係に注意)spring:swagger 2:enable:true
第4歩controllerでクラス名に注記@Api(description=「自分の必要な名前を記入する」)を導入する
メソッド名には以下の注記@ApiOperation(value=「インタフェース名」,notes=「インタフェース名メソッド」)@ApiImpliitParams({@ApiImpliitParam(paramType=「query」,name=「index」,value=「ソート」,required=true,dataType=「String」),@ApiImpliitParam(paramType=「query」,name=「page」,value=「ページ番号」,required=true,datdataType=「String」),@ApiImppliitParam(paramType=「query」,name=「page」,value=「ページ番号」,required=true,datdataquired=true aType="Integer"),@ApiImplicitParam(paramType="query",name="size",value="本数",required=true,dataType="Integer"),注意:リクエスト方式はpostかgetかをはっきり書くことをお勧めしますここにRequestMappingと書いたら自分で効果を見ることができます
ステップ5では、あなたの起動クラスメソッド名に@EnableSwagger 2を導入して起動に成功したらアクセスできます.例:私の起動ポートは80です.では、ブラウザに直接入力します.http://localhost:80/swagger-ui.htmlでOK
io.springfox
springfox-swagger2
2.7.0
io.springfox
springfox-swagger-ui
2.7.0
ステップ2 configフォルダの下にコンフィギュレーションクラスを作成します.SwaggerConfigコードと名前を付けます.
@Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket api() { return new Docket(DocumentationType.SWAGGER_2) .select() .apis(RequestHandlerSelectors.basePackage("*******.controller")) .paths(PathSelectors.any()) .build() .apiInfo(apiInfo()); } private ApiInfo apiInfo(){return new ApiInfoBuilder().title("テストAPI").description("テストインタフェースの説明").version("1.0").build();
}说明:.basePackageにあなたのcontrollerがいるフォルダの位置を記入します.
第3歩springbootプロファイルにプロファイルを追加するここで使用するのは.ymlファイル(階層関係に注意)spring:swagger 2:enable:true
第4歩controllerでクラス名に注記@Api(description=「自分の必要な名前を記入する」)を導入する
メソッド名には以下の注記@ApiOperation(value=「インタフェース名」,notes=「インタフェース名メソッド」)@ApiImpliitParams({@ApiImpliitParam(paramType=「query」,name=「index」,value=「ソート」,required=true,dataType=「String」),@ApiImpliitParam(paramType=「query」,name=「page」,value=「ページ番号」,required=true,datdataType=「String」),@ApiImppliitParam(paramType=「query」,name=「page」,value=「ページ番号」,required=true,datdataquired=true aType="Integer"),@ApiImplicitParam(paramType="query",name="size",value="本数",required=true,dataType="Integer"),注意:リクエスト方式はpostかgetかをはっきり書くことをお勧めしますここにRequestMappingと書いたら自分で効果を見ることができます
ステップ5では、あなたの起動クラスメソッド名に@EnableSwagger 2を導入して起動に成功したらアクセスできます.例:私の起動ポートは80です.では、ブラウザに直接入力します.http://localhost:80/swagger-ui.htmlでOK