swagger2：在項目配置swagger

1、新建一個springboot項目（或者其他項目也行）

 　　項目結構：

　　　　

 

 

2、在pox文件導入依賴：

　　

<依賴性>  <的groupId> io.springfox </的groupId>  <artifactId的> springfox-swagger2 </ artifactId的>  <版本> 2.9。2 </版本>  </依賴性>  <依賴性>  <的groupId> io.springfox </的groupId>  <artifactId的> springfox-招搖-UI </ artifactId的>  <版本> 2.9。2 </版本>  </依賴性>

 

3、編寫配置類

@Configuration//加入容器 @EnableSwagger2//開啟swagger2功能
public class SwaggerConfig { /** * 創建API應用 * apiInfo() 增加API相關信息 * 通過select()函數返回一個ApiSelectorBuilder實例,用來控制哪些接口暴露給Swagger來展現， * 本例采用指定掃描的包路徑來定義指定要建立API的目錄。
     * * @返回
     */ @豆
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                //通過調用自定義方法apiInfo，獲得文檔的主要信息
                .apiInfo(apiInfo()) 。選擇（）
                .apis(RequestHandlerSelectors.any())//掃描所有
                .paths(PathSelectors.any()) 。建立（）; }
    私人ApiInfo apiInfo（）{ 返回 新的ApiInfoBuilder（）
                .title("使用Swagger2 ") //接口管理文檔首頁顯示
                .description("Swagger使用演示")//API的描述
                .termsOfServiceUrl("url")//網站url等
                .version("1.0") 。建立（）; }
}

 

4、在controller類或者實體類添加接口注解

　　注解解釋：

　　　　- @Api()用於類；

　　　　　　　　表示標識這個類是swagger的資源
　　　　- @ApiOperation()用於方法；
　　　　　　　　表示一個http請求的操作
　　　　- @ApiParam()用於方法，參數，字段說明；
　　　　　　　　表示對參數的添加元數據（說明或是否必填等）
　　　　- @ApiModel()用於類
　　　　　　　　表示對類進行說明，用於參數用實體類接收
　　　　- @ApiModelProperty()用於方法，字段
　　　　　　　　表示對model屬性的說明或者數據操作更改
　　　　- @ApiIgnore()用於類，方法，方法參數
　　　　　　　　表示這個方法或者類被忽略
　　　　- @ApiImplicitParam() 用於方法
　　　　　　　　表示單獨的請求參數
　　　　- @ApiImplicitParams() 用於方法，包含多個 @ApiImplicitParam

　　當然還有很多，具體自己要用到在查

 

5、測試

　　　訪問地址：

    　　springboot項目是：http://localhost:8080/swagger-ui.html

　　　非springboot項目：http://localhost:端口號/項目名稱/swagger-ui.html