聲明:
此文章只講述Spring-Boot如何集成和使用Swagger2
下面開始具體步驟:
第一步:導(dǎo)入依賴jar包
建議直接在父工程的pom文件中導(dǎo)入,其下的子工程都可以直接使用,無需再次導(dǎo)包率挣,方便
<dependency>
????<groupId>io.springfox</groupId>
????<artifactId>springfox-swagger-ui</artifactId>
????<version>2.9.2</version>
</dependency>
<dependency>
????<groupId>io.springfox</groupId>
????<artifactId>springfox-swagger2</artifactId>
????<version>2.9.2</version>
</dependency>
第二步:編寫Swagger的配置類
在所需要使用swagger的子工程里編寫此配置類
@Configuration
@EnableSwagger2
public class Swagger2Configuration {
????//api接口包掃描路徑
????public static final String SWAGGER_SCAN_BASE_PACKAGE = "com.changgou.goods";
????public static final String VERSION = "1.0.0";
????@Bean
????public Docket createRestApi() {
????????return new Docket(DocumentationType.SWAGGER_2)
????????????????????.apiInfo(apiInfo())
????????????????????.select() ????????????????????
????????????????????.apis(RequestHandlerSelectors.basePackage(SWAGGER_SCAN_BASE_PACKAGE)) ????????????????????.paths(PathSelectors.any()) // 可以根據(jù)url路徑設(shè)置哪些請求加入文檔菠发,忽略哪些請求
????????????????????.build();
}
????private ApiInfo apiInfo() {
????????return new ApiInfoBuilder()
????????????????????.title("單詞計數(shù)服務(wù)") //設(shè)置文檔的標(biāo)題
????????????????????.description("單詞計數(shù)服務(wù) API 接口文檔") // 設(shè)置文檔的描述
????????????????????.version(VERSION) // 設(shè)置文檔的版本信息-> 1.0.0 Version information? ? ? ? ? ? ? ? ? ?
????????????????????.termsOfServiceUrl("http://www.baidu.com") // 設(shè)置文檔的License信息->1.3 Licensinformation
????????????????????.build();
????}
}
第三步:開始使用
瀏覽器輸入:
http://localhost:9001/swagger-ui.html
即可訪問笼痛,注意:ip和端口根據(jù)自身啟動的項目編寫
登陸成功后顯示如下圖:
展開類維度的接口列表祈秕,如brand-controller唯蝶,頁面會列出該類中定義的所有接口访雪。點(diǎn)擊任意接口详瑞,可查看該接口的 url 路徑、請求類型冬阳、參數(shù)描述和返回碼說明等信息蛤虐。
這里我們來測試一下findById這個接口
點(diǎn)擊Try it out可以傳入?yún)?shù)進(jìn)行測試