swagger2中怎么構建RestfulAPI

swagger2中怎么構建RestfulAPI，很多新手對此不是很清楚，為了幫助大家解決這個難題，下面小編將為大家詳細講解，有這方面需求的人可以來學習下，希望你能有所收獲。

在pom.xml中進行版本管理

<swagger.version>2.8.0</swagger.version>

給taosir-api的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@Configurationpublic 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-ui.html#

以上，集成swagger2構建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：用在屬性上，描述響應類的屬性

看完上述內容是否對您有幫助呢？如果還想對相關知識有進一步的了解或閱讀更多相關文章，請關注億速云行業資訊頻道，感謝您對億速云的支持。