どうやってswagger 2を集めてRestful APIを構築しますか?
この文章は主にswagger 2を統合してRetsful APIを構築する方法を紹介しています。ここでは例示的なコードを通じて紹介された非常に詳細で、皆さんの学習や仕事に対して一定の参考となる学習価値があります。必要な友達は以下のように参照してください。
pom.xmlでバージョン管理を行います。
taosir-eureka登録センター
taosir-dreamHouseサービスプロバイダ
taoisr-apiサービス消費者
アクセスアドレスhttp://localhost:8765/swagger-ルイ.
以上、swagger 2を統合してRestful APIを構築します。
以下に注釈の参考書を添付します。
pom.xmlでバージョン管理を行います。
<swagger.version>2.8.0</swagger.version>
taosir-appiのpom.xmlに依存配置を追加します。
<!-- swagger start -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>${swagger.version}</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>${swagger.version}</version>
</dependency>
設定クラスを追加
package cn.taosir.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;
@EnableSwagger2
@Configuration
public class SwaggerConfiguration {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
//
// ,
//@ApiIgnore , swagger2
.apis(RequestHandlerSelectors.basePackage("cn.taosir.api.controller"))
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title(" ")
.version("1.0")
.description("API ")
.build();
}
}
コントロール層に対応するコメントを追加します。
package cn.taosir.api.controller.dreamhouse;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;
import cn.taosir.service.dreamHouse.UserService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
@RestController
@Api(value = " " ,tags = {" "})
public class UserController {
@Autowired
private UserService userService;
@ApiOperation(value=" ", notes=" ")
@RequestMapping(value="/test",method=RequestMethod.GET)
public String test() {
return userService.test();
}
}
順番に起動しますtaosir-eureka登録センター
taosir-dreamHouseサービスプロバイダ
taoisr-apiサービス消費者
アクセスアドレスhttp://localhost:8765/swagger-ルイ.
以上、swagger 2を統合してRestful APIを構築します。
以下に注釈の参考書を添付します。
@Api: ,
tags=" , UI "
value=" , UI , "
@ApiOperation: , 、
value=" 、 "
notes=" "
@ApiImplicitParams: ,
@ApiImplicitParam: @ApiImplicitParams ,
name:
value: 、
required:
paramType:
・ header --> :@RequestHeader
・ query --> :@RequestParam
・ path( restful )--> :@PathVariable
・ body( )
・ form( )
dataType: , String, dataType="Integer"
defaultValue:
@ApiResponses: ,
@ApiResponse: @ApiResponses ,
code: , 400
message: , " "
response:
@ApiModel: ,
( post , @RequestBody ,
@ApiImplicitParam )
@ApiModelProperty: ,
以上が本文の全部です。皆さんの勉強に役に立つように、私たちを応援してください。