datadog/apigentools

apigentools - 轻松生成API客户端

镜像概述和主要用途

apigentools镜像旨在提供一种便捷方式，使用https://github.com/OpenAPITools/openapi-generator%E4%BB%8Ehttps://github.com/OAI/OpenAPI-Specification/%E4%B8%BA%E5%A4%9A%E7%A7%8D%E8%AF%AD%E8%A8%80%E7%94%9F%E6%88%90API%E5%AE%A2%E6%88%B7%E7%AB%AF%E3%80%82%E8%AF%A5%E9%95%9C%E5%83%8F%E5%8C%85%E5%90%AB%E5%BF%85%E8%A6%81%E7%9A%84%E5%B7%A5%E5%85%B7%E5%92%8C%E9%85%8D%E7%BD%AE%EF%BC%8C%E6%94%AF%E6%8C%81%E5%8F%AF%E9%87%8D%E7%8E%B0%E7%9A%84%E4%BB%A3%E7%A0%81%E7%94%9F%E6%88%90%E3%80%81%E6%8E%A8%E8%8D%90%E5%B7%A5%E4%BD%9C%E6%B5%81%E4%BB%A5%E5%8F%8A%E6%A8%A1%E6%9D%BF%E8%87%AA%E5%AE%9A%E4%B9%89%EF%BC%8C%E7%AE%80%E5%8C%96API%E5%AE%A2%E6%88%B7%E7%AB%AF%E7%9A%84%E7%94%9F%E6%88%90%E5%92%8C%E7%AE%A1%E7%90%86%E8%BF%87%E7%A8%8B%E3%80%82

核心功能和特性

• Spec Repo结构定义：支持Spec Repo结构的定义，即包含apigentools和openapi-generator的所有配置以及API的实际OpenAPI规范的仓库。
• 可重现的代码生成：确保代码生成过程可重现，便于团队协作和版本控制。
• 推荐工作流：提供推荐工作流，指导用户高效完成API客户端生成流程。
• 模板自定义能力：支持修补openapi-generator模板以及添加自定义模板，满足个性化需求。

使用场景和适用范围

适用于需要为API生成多语言客户端的开发团队，特别是：

• 需要从OpenAPI v3规范自动生成API客户端代码的场景。
• 要求代码生成过程可重现、便于版本控制的团队。
• 需要自定义生成模板以适配特定项目需求的开发工作流。
• 希望简化多语言API客户端维护流程的开发人员。

详细使用方法和配置说明

获取镜像

拉取最新版本的apigentools镜像：

bash
docker pull datadog/apigentools:latest

基本使用

启动交互式容器以执行apigentools命令：

bash
docker run -it --rm datadog/apigentools:latest /bin/bash

挂载Spec Repo目录

若需使用本地Spec Repo（包含配置和OpenAPI规范的仓库），可通过卷挂载实现：

bash
docker run -it --rm -v /本地/spec-repo路径:/spec-repo datadog/apigentools:latest /bin/bash

进入容器后，可在/spec-repo目录下执行生成命令，例如为Python生成客户端：

bash
apigentools generate -s /spec-repo -l python

相关资源

• 官方文档：[***]
• PyPI安装：若需本地安装工具而非使用容器，可通过pip install apigentools获取apigentools。