推薦一款接口 API 設計神器！
作者：棧長
今天給大家推薦一款接口 API 設計神器，傳說中的，牛逼哄洪的 Swagger，它到底是什么？今天為大家揭開謎底！
今天棧長給大家推薦一款接口 API 設計神器，傳說中的，牛逼哄洪的 Swagger，它到底是什么？今天為大家揭開謎底！
Swagger是什么？
Swagger 如官網所示，它是***的 API 構建工具。
它是一個圍繞 OpenAPI 規范構建的開源工具，它可以幫助我們設計、構建、記錄和使用 REST API 接口。
Swagger 包含的主要套件：
- Swagger Editor - 基于瀏覽器的編輯器，用來編寫 OpenAPI 規范。
- Swagger UI - 基于 OpenAPI 規范動態生成 API 規范文檔。
- Swagger Codegen - 個模板驅動引擎，用來生成客戶端代碼。
圖片來源見博客水印。
OpenAPI是什么？
上面有說到 Swagger 是一個圍繞 OpenAPI 規范構建的開源工具，那么 OpenAPI 是什么呢？
OpenAPI 規范，以前叫 Swagger 規范。它是一個為 REST APIs的接口定義的規范。OpenAPI 可以定義的 API 實體內容包括以下幾個部分。
- 請求地址（如：/user）
- 請求類型（如：GET、POST 等）
- 請求參數
- 響應參數
- 驗證方式
- 文檔信息：如聯系人、許可證、服務條件等
這個 OpenAPI 規范可以用 YAML 或者 JSON 來編寫，這種格式非常易于學習，可讀性對開發人員非常友好。
完整的 OpenAPI 規范可以去官網看一下。
編寫文檔地址：
為什么需要Swagger？
現在的互聯網架構都是前后端分離的模式，還有現在是移動互聯網時代了，APP 需要與后端服務器通信也需要維護一套接口，API文檔自然就成了前后端開發人員聯系的紐帶。
編寫 API 文檔的方式也各有不同，有用 WORD 編寫的，有用 confluence 等編寫的，但這些方式都不能動態更新，每次接口變更都需要手動維護文檔，甚是麻煩。有了 Swagger，可以先做完接口，通過 Swagger 來動態生成和更新 API 文檔。
后面的文章會繼續介紹如何使用 Swagger 注解來自動生成 API 文檔，及如何集成 Spring Boot 來應用實戰。
責任編輯：張燕妮
來源：
Java技術棧
