使用 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 都可以只关注对您最重要的内容，从而节省您的时间和精力。