swagger2是一個構建強大的在線的restful API文檔,并提供給不同的團隊,更加快速進行開發,也更加便捷部署。
swagger2的配置步驟:
一、首先在pom文件內配置依賴,由于項目是spring boot聚合工程所以是寫在common項目內的pom內
<!-- swagger2 配置依賴 -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.4.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.4.0</version>
</dependency>
二、對swagger2進行配置
在Application的同級目錄創建一個swagger2類
package com.imooc;
import java.util.ArrayList;
import java.util.List;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.ParameterBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.service.Parameter;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@Configuration
@EnableSwagger2
public class Swagger2 {
/**
* @Description:swagger2的配置文件,這里可以配置swagger2的一些基本的內容,比如掃描的包等等
*/
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()
.apis(RequestHandlerSelectors.basePackage("com.imooc.controller"))
.paths(PathSelectors.any()).build();
}
/**
* @Description: 構建 api文檔的信息
*/
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
// 設置頁面標題
.title("使用swagger2構建短視頻后端api接口文檔")
// 設置聯系人
.contact(new Contact("hph", "wx:13052019756", "huangpenghui68@163.com"))
// 描述
.description("歡迎訪問短視頻接口文檔,這里是描述信息")
// 定義版本號
.version("1.0").build();
}
}
三、對接口進行編寫打開controller
三、進入Users對象內
四、點擊項目,run as -- Maven install 成功后在console里邊會出現 BUILD SUCCESS 這時候在點擊Application啟動類 run as --spring boot App 啟動完后在網站訪問http://localhost:8090/swagger-ui.html? 我自己的端口號是:8090?