Swagger使用配置詳解

swagger專案公司一直在使用，沒時間整理下，現在抽空做個記錄，方便以後檢視。

io.springfox
springfox-swagger2
2.2.2
io.springfox
springfox-swagger-ui
2.2.2

package com.graduation.design.config;

import org.springframework.context.annotation.bean;
import org.springframework.context.annotation.configuration;
import org.springframework.web.servlet.config.annotation.resourcehandlerregistry;
import org.springframework.web.servlet.config.annotation.webmvcconfigurationsupport;
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;
/** * @author: xieyong
* @date: 2019/5/5 22:44
* @description:
*/@configuration
@enableswagger2
public class swagger2config extends webmvcconfigurationsupport 
private apiinfo apiinfo() 
/*** 防止@enablemvc把預設的靜態資源路徑覆蓋了，手動設定的方式
** @param registry
*/@override
protected void addresourcehandlers(resourcehandlerregistry registry) 
}

@restcontroller

@api(value = "/v1/device/manager/detail", description = "裝置管理-裝置詳情",tags = "裝置管理-裝置詳情介面")
public class activedetailcontroller )
public result querydevicebyactivebyid(@requestparam(value="activeid", required=true)long activeid) 
}

@apimodel 註解在類上，一般是實體類

@apioperation 註解在方法上，表明方法級解釋

@apiimplicitparams 註解在方法上，一般與@apiimplicitparam共用，多個引數逗號隔開,表請求引數

@apiresponses 註解在方法上表響應，一般與@apiresponse公用

swagger使用詳解

swagger 的目標是為rest apis 定義乙個標準的,與語言無關的介面,使人和計算機在看不到原始碼或者看不到文件或者不能通過網路流量檢測的情況下能發現和理解各種服務的功能。當服務通過swagger定義,消費者就能與遠端的服務互動通過少量的實現邏輯。類似於低階程式設計介面,swagger去掉了...

swagger2配置詳解

api tags 使用者相關介面 description 提供使用者相關的 rest api public class usercontroller屬性解析 註解屬性 型別描述 br 控制器標籤。description string 控制器描述 該字段被申明為過期 apioperation 主要屬性...

Swagger 常用註解使用詳解

剛開始的時候，在controller層使用 requestparam的時候，發現這個引數是必須要輸入值的，但是我們有時候必須查詢的時候允許引數為空，使用這個註解就不行了。在整合了swagger2後，找了半天的原因，發現使用 apiimplicitparam這個註解可以解決這個問題。對應下面的引數。所...