如何利用 Swagger 消除前后端分離的障礙


以前前后端協作的方式

  1. 后端丟個接口的契約代碼給你
  2. 后端寫到wiki里,代碼更新,文檔更新不及時

Swagger

Swagger 是很多產品的總稱。包含最核心的規范 Swagger Specification,編輯器 Swagger Editor,圖形界面 Swagger UI,代碼生成器 Swagger Codegen,成熟的產品 SwaggerHub 等。

Swagger 的主要作用是描述 RESTful API,生成交互式文檔,便於前后端開發人員查看請求信息和響應數據。

我們目前常用 Swagger 的版本為 Swagger 2.0

寫Swagger配置文件

  1. 代碼注解生成
    Spring Boot集成Swagger
    如今,Swagger 與 Spring Boot 的無縫對接,簡直就是不願寫文檔的猿類的福音。
    http://blog.didispace.com/springbootswagger2/

  2. 手動編寫 Swagger 規范

  • YAML 格式
  • JSON格式

這一步,輸出的是一個文檔的URL地址,和一個JSON/YAML格式的Swagger文件。

前端導入Swagger文檔,生成MOCK服務

  1. easymock
    大搜車出品 輸入Swagger文檔地址,就可生成接口
    https://easy-mock.com
  2. Yapi
    去哪兒出品
    https://yapi.ymfe.org/

參考


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM