Jex’s Note

產生 API 文件

swagger-ui

Introduction

swagger 是個介面, 有許多語言實作它, 但 swagger-ui 不是跟任何語言綁定, 它只讀 json, 然候生成 api 文件

撰寫 API 文件

可用 online swagger IDE, 匯入 json, 寫完再匯出 json 放到自己的 code 裡

其他

  • swagger 上面可以讀外部連結的 json, 如果沒有跨 domain 問題就可以讀取
  • 可以設定 access key 給不同人, 然候 public 這個 api 文件, 讓只有 access key 的人才可以用這個 api

Comments