使用 OpenAPI Trimmer 簡化您的 OpenAPI 文件

管理大型 OpenAPI 檔案可能會很麻煩，尤其是當您只需要一小部分 API 來執行特定任務時。這就是 OpenAPI Trimmer 派上用場的地方。它是一個輕量級工具，旨在精簡您的 OpenAPI 文件，使其僅包含您關心的端點和資料傳輸物件 (DTO)。

它是如何運作的？

假設您正在使用一個大型 OpenAPI 文件，但您只需要與 Quotes API 相關的端點。您可以使用單一命令輕鬆提取這些端點並刪除不相關的 DTO：

openapi-trimmer -i openapi.yaml \
  -p /v1/quotes,/v1/users \
  -ec CompanyConfigDto,UpdateCompanyConfigDto

該命令將：

• -i openapi.yaml：使用現有的 OpenAPI YAML 檔案作為輸入。
• -p /v1/quotes,/v1/users：僅保留以 /v1/quotes 和 /v1/users 開頭的端點。
• -ec CompanyConfigDto,UpdateCompanyConfigDto：排除特定元件，在本例中為 CompanyConfigDto 和 UpdateCompanyConfigDto。

修剪後的 API 定義將儲存為 openapi-trimmer.yaml。

驗證

為了確保修剪後的 OpenAPI 檔案的完整性，請使用以下命令進行驗證：

swagger-cli validate ./openapi-trimmer.yaml

此步驟有助於在部署或共用修剪後的 API 檔案之前發現任何問題。

安裝

您可以直接從 PyPi 安裝 OpenAPI Trimmer:

pip install openapi-trimmer

有關更多詳細資訊和最新更新，請造訪 OpenAPI Trimmer PyPi 頁面。

GitHub 儲存庫：GitHub 上的 OpenAPI Trimmer。

命令列選項

OpenAPI Trimmer 提供了多個選項來自訂其操作：

• -h, --help：顯示幫助資訊。
• -v, --version：顯示版本號。
• -i INPUT, --input INPUT：指定輸入YAML檔案（必填）。
• -o OUTPUT, --output OUTPUT：定義輸出檔名（可選；預設將「-trimmed」附加到輸入檔）。
• -p PREFIXES, --prefixes PREFIXES：列出輸出中要保留的路徑（以逗號分隔）。
• -ec EXCLUDE_COMPONENTS, --exclude-components EXCLUDE_COMPONENTS：列出要排除的元件（以逗號分隔）。

結論

OpenAPI Trimmer 是希望簡化 OpenAPI 檔案的開發人員的必備工具，使它們更易於管理並根據特定需求進行客製化。無論您是準備 API 文件還是簡化 API 供內部使用，OpenAPI Trimmer 都可以只專注於對您最重要的內容，從而節省您的時間和精力。