使用 swagger-cli 打包並驗證 OpenAPI 檔案,產生可發布的規格 是做什麼的?
將多檔案 OpenAPI 定義解析為一個經過驗證的成品,以便在文件、程式碼生成或 CI 閘道依賴該規格之前先行處理。
先決條件
需要 Node.js、npm 或 npx,以及一個或多個 Swagger/OpenAPI JSON 或 YAML 檔案,並根據需要包含本地或遠端的 $ref 目標。
安裝
根據您的環境選擇上游安裝或設定路徑:
- npm install -g @apidevtools/swagger-cli
- git clone https://github.com/APIDevTools/swagger-cli.git
- npm install
- npm test
上游的要求與注意事項:
- 有一個實用的 Python 工具叫做 pre-commit,可以用來執行廣泛的預提交檢查。swagger-cli 的 validate 命令可以整合為 git 預提交檢查的一部分...
基本用法或入門說明:
-
bash
-
swagger-cli [options]
-
從上游文件提取:https://raw.githubusercontent.com/APIDevTools/swagger-cli/HEAD/README.md