Swagger Open API 使用

在官方 swagger 提供幾個工具給大家使用,

Swagger-ui:https://github.com/swagger-api/swagger-ui

swagger-ui

主要提供一個 swagger 的核心可以用來讀取網路上的 json 或是 yaml 來使用,
架設後可以建立私人的 API Server 讓其他開發者可以直接用此服務測試習慣 API 的使用,
不過如果需求是使用私人的加密方法可能就沒辦法使用這個服務了,
因為此服務中沒有辦法做判斷與計算。
快速安裝方法只要有 Docker 用 docker run -p 80:8080 swaggerapi/swagger-ui

Swagger-editor:https://github.com/swagger-api/swagger-editor

swagger-editor

一個可以線上編輯 swagger 的服務,
如果用此服務編輯可以即時候看到右邊的 API 變化,
是一個滿不錯的開發工具,
編輯完的 json 或是 yaml 可以直接儲存起來給 swagger ui 讀取。

Swagger-editor 算是開發中而 Swagger-ui 主要是給開發後的使用。