如何利用 Swagger 消除先後端分離的障礙

之前先後端協做的方式

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

Swagger

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

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

咱們目前經常使用 Swagger 的版本爲 Swagger 2.0後端

寫Swagger配置文件

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

  2. 手動編寫 Swagger 規範
  • YAML 格式
  • JSON格式

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

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

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

參考

相關文章
相關標籤/搜索