溫馨提示×
您好，登錄后才能下訂單哦！
點擊 登錄注冊 即表示同意《億速云用戶服務條款》
您好，登錄后才能下訂單哦！
如果你所在的公司的還沒有使用swagger甚至沒有聽說過swagger，趕快學習一下我的這篇博客吧，五分鐘速成，傻瓜式的集成，但就是這么簡單的應用一定會讓他們震驚到的。
首先對swagger做一個簡介吧：swagger是后臺開發的神器，也是前后端交流的渠道。你可以用swagger做什么？首先，你以后基本可以告別單元測試了；其次，你不用再寫接口文檔了，也不需要寫完之后再去對文檔進行維護了。swagger可以完全模擬http請求，入參出參和實際情況差別幾乎為零。說了這些，直接來干貨吧！
集成四部曲：
第一步：導入兩個依賴吧，如果你不是maven項目，那你去找找jar包吧，記住只需要兩個，我看別的教程引入了七八個，簡直是浪費。
<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.6.1</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.6.1</version> </dependency>
第二步：添加一個類（拷貝下面的即可，注意修改包名，地址）
/**
* Swagger配置
*
* @author wq
* @since 2017-05-16
*/
@EnableWebMvc
@EnableSwagger2
@Configuration
public class SwaggerConfig {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com.z*.b*.c*.controller"))
// 注意修改此處的包名
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("接口列表 v1.1.0") // 任意，請稍微規范點
.description("接口測試") // 任意，請稍微規范點
.termsOfServiceUrl("http://url/swagger-ui.html")
// 將“url”換成自己的ip:port
.contact("laowu") // 無所謂（這里是作者的別稱）
.version("1.1.0")
.build();
}
}
第三步：在mvc的配置的文件中添加下面配置，可能你的文件也許是叫 dispatcher.xml！（照抄即可，完全不需要修改）
<mvc:resources mapping="swagger-ui.html" location="classpath:/META-INF/resources/"/> <mvc:resources mapping="/webjars/**" location="classpath:/META-INF/resources/webjars/"/>
第四步：在方法和參數上添加注解
方法上：
@ApiOperation(value = "教程", httpMethod = "POST", notes = "教程")
放在入參中：
@ApiParam(required = true, name = "test", value = "教程入參")
擔心有些朋友還不太明白，放張圖吧！
第五步：啟動服務，然后在瀏覽器輸入：
http://ip:port/swagger-ui.html
出現下面的畫面就代表大功告成：
注意事項：如果你的項目中使用了攔截器，請將swagger資源放行（還是可以直接拷貝下面的配置，全部，不要懷疑v2）
<mvc:exclude-mapping path="/swagger*/**"></mvc:exclude-mapping> <mvc:exclude-mapping path="/v2/**"></mvc:exclude-mapping> <mvc:exclude-mapping path="/webjars/**"></mvc:exclude-mapping>
以上就是本文的全部內容，希望對大家的學習有所幫助，也希望大家多多支持億速云。
免責聲明：本站發布的內容（圖片、視頻和文字）以原創、轉載和分享為主，文章觀點不代表本網站立場，如果涉及侵權請聯系站長郵箱：is@yisu.com進行舉報，并提供相關證據，一經查實，將立刻刪除涉嫌侵權內容。
