swagger的簡單使用

swagger 是乙個規範和完整的框架，用於生成、描述、呼叫和視覺化 restful 風格的 web 服務。總體目標是使客戶端和檔案系統作為伺服器以同樣的速度來更新。檔案的方法，引數和模型緊密整合到伺服器端的**，允許api來始終保持同步

在pom.xml中加入swagger2的依賴

配置依賴

io.springfox

springfox-swagger2
io.springfox
springfox-swagger-ui

@configuration

@enableswagger2

public class swaggerconfig

private apiinfo webapiinfo()

@autowired

private edusubjectservice subjectservice;
//新增課程分類
@apioperation(value = "excel批量匯入")
public r addsubject(multipartfile file)
@apioperation(value = "巢狀資料列表")
public r nestedlist()

最後啟動spring boot程式，訪問：http://localhost:8001/swagger-ui.html

注意：埠號是啟動spring boot程式預設的或自己配置的

swagger2的簡單使用

優點 可以生成文件形式的api並提供給不同的團隊使用 便於自己單測 無需過多冗餘的word文件，這一點很重要，因為我在工作中就遇到這麼乙個情況，由於開發使用的文件和最新文件版本導致不一致，導致後期很煩人 使用swagger流程 1.引入pom依賴 io.springfox springfox swa...

swagger註解的使用

apiimplicitparams 5.apiresponses 用於表示一組響應 6.apiresponse 用在 apiresponses中，一般用於表達乙個錯誤的響應資訊 code 數字，例如400 message 資訊，例如 請求引數沒填好 response 丟擲異常的類 apirespon...

Swagger 的基本使用

在專案中使用 swagger 新建乙個 springboot web 專案 匯入相關依賴 io.springfoxgroupid springfox swagger2artifactid 2.9.2version dependency io.springfoxgroupid springfox sw...