集成swagger2構(gòu)建RestfulAPI的示例-創(chuàng)新互聯(lián)
這篇文章給大家分享的是有關(guān)集成swagger2構(gòu)建Restful API的示例的內(nèi)容。小編覺得挺實用的，因此分享給大家做個參考，一起跟隨小編過來看看吧。
為藤縣等地區(qū)用戶提供了全套網(wǎng)頁設(shè)計制作服務(wù)，及藤縣網(wǎng)站建設(shè)行業(yè)解決方案。主營業(yè)務(wù)為成都做網(wǎng)站、網(wǎng)站制作、藤縣網(wǎng)站設(shè)計，以傳統(tǒng)方式定制建設(shè)網(wǎng)站，并提供域名空間備案等一條龍服務(wù)，秉承以專業(yè)、用心的態(tài)度為用戶提供真誠的服務(wù)。我們深信只要達(dá)到每一位用戶的要求，就會得到認(rèn)可，從而選擇與我們長期合作。這樣，我們也可以走得更遠(yuǎn)！在pom.xml中進(jìn)行版本管理
2.8.0
給taosir-api的pom.xml中添加依賴配置
io.springfox springfox-swagger2 ${swagger.version} io.springfox springfox-swagger-ui ${swagger.version}
添加配置類
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("濤先森系統(tǒng)入口業(yè)務(wù)測試")
.version("1.0")
.description("API 描述")
.build();
}
}為控制層添加相應(yīng)注解
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="測試是否成功使用服務(wù)發(fā)現(xiàn)")
@RequestMapping(value="/test",method=RequestMethod.GET)
public String test() {
return userService.test();
}
}按順序啟動
taosir-eureka注冊中心
taosir-dreamHouse服務(wù)提供者
taoisr-api服務(wù)消費者
訪問地址 http://localhost:8765/swagger-ui.html#
以上，集成swagger2構(gòu)建Restful API
下面附上注解參考表
@Api：用在請求的類上，表示對類的說明 tags="說明該類的作用，可以在UI界面上看到的注解" value="該參數(shù)沒什么意義，在UI界面上也看到，所以不需要配置" @ApiOperation：用在請求的方法上，說明方法的用途、作用 value="說明方法的用途、作用" notes="方法的備注說明" @ApiImplicitParams：用在請求的方法上，表示一組參數(shù)說明 @ApiImplicitParam：用在@ApiImplicitParams注解中，指定一個請求參數(shù)的各個方面 name：參數(shù)名 value：參數(shù)的漢字說明、解釋 required：參數(shù)是否必須傳 paramType：參數(shù)放在哪個地方 · header --> 請求參數(shù)的獲取：@RequestHeader · query --> 請求參數(shù)的獲?。篅RequestParam · path（用于restful接口）--> 請求參數(shù)的獲取：@PathVariable · body（不常用） · form（不常用） dataType：參數(shù)類型，默認(rèn)String，其它值dataType="Integer" defaultValue：參數(shù)的默認(rèn)值 @ApiResponses：用在請求的方法上，表示一組響應(yīng) @ApiResponse：用在@ApiResponses中，一般用于表達(dá)一個錯誤的響應(yīng)信息 code：數(shù)字，例如400 message：信息，例如"請求參數(shù)沒填好" response：拋出異常的類 @ApiModel：用于響應(yīng)類上，表示一個返回響應(yīng)數(shù)據(jù)的信息 （這種一般用在post創(chuàng)建的時候，使用@RequestBody這樣的場景， 請求參數(shù)無法使用@ApiImplicitParam注解進(jìn)行描述的時候） @ApiModelProperty：用在屬性上，描述響應(yīng)類的屬性
感謝各位的閱讀！關(guān)于“集成swagger2構(gòu)建Restful API的示例”這篇文章就分享到這里了，希望以上內(nèi)容可以對大家有一定的幫助，讓大家可以學(xué)到更多知識，如果覺得文章不錯，可以把它分享出去讓更多的人看到吧！
另外有需要云服務(wù)器可以了解下創(chuàng)新互聯(lián)建站www.cdcxhl.com，海內(nèi)外云服務(wù)器15元起步，三天無理由+7*72小時售后在線，公司持有idc許可證，提供“云服務(wù)器、裸金屬服務(wù)器、高防服務(wù)器、香港服務(wù)器、美國服務(wù)器、虛擬主機(jī)、免備案服務(wù)器”等云主機(jī)租用服務(wù)以及企業(yè)上云的綜合解決方案，具有“安全穩(wěn)定、簡單易用、服務(wù)可用性高、性價比高”等特點與優(yōu)勢，專為企業(yè)上云打造定制，能夠滿足用戶豐富、多元化的應(yīng)用場景需求。
當(dāng)前名稱：集成swagger2構(gòu)建RestfulAPI的示例-創(chuàng)新互聯(lián)
當(dāng)前鏈接：http://m.jiaotiyi.com/article/cogcid.html