OpenAPI Python 发电机

OpenAPI Python 生成器工具根据您的 OpenAPI 规范 3.0 规范创建 Python FastAPI 服务器代码。 这些代码可帮助您快速构建在 OpenAPI 文档中定义的 API 端点,这样您就可以专注于实现业务逻辑,而不是编写模板代码。

重要提示: 请确保您已提前创建了 OpenAPI 文档
主要亮点
  • 根据输入的 OpenAPI 3.0 规范生成 Python FastAPI 后端服务器。
  • 支持生成三种不同的服务器类型:
    • 用于模拟 API 响应的简单服务器。
    • 数据库创建、检索、更新和删除 直接与数据库交互的服务器。
    • 用于与 IBM Connectivity Pack 应用程序交互的 Connector Pack Server。
OpenAPI Python 生成器工具支持以下操作:
表 1. 参数
参数 必需 描述 缺省值
input_file OpenAPI YAML 或 JSON 格式的规范。
server_type False 要生成的服务器类型。 空白(表示简单服务器类型)
database_type False 生成数据库 CRUD 类型服务器时要使用的数据库语言类型 Postgres

简单服务器

极简服务器,为您提供开始构建服务所需的基本设置。

示例提示
Generate some Python FastAPI server code based on the following openapi @<filename.yaml>

数据库 CRUD 服务器

简单服务器的扩展,包含数据库逻辑,可直接在自己的数据库上执行创建、读取、更新和删除(CRUD)操作。 这种类型适用于需要持久数据管理的应用。 您还可以指定要使用的数据库语言,默认情况下使用 Postgres ,但也可以使用 DynamoDB 和 Db2。

提示示例
Generate some Python FastAPI server with database interaction code based on the following openapi @<filename.yaml>

Generate some Python FastAPI server with postgres database interaction code based on the following openapi @<filename.yaml>

Generate some Python FastAPI server with dynamodb database interaction code based on the following openapi @<filename.yaml>

Generate some Python FastAPI server with db2 database interaction code based on the following openapi @<filename.yaml>

连接器包服务器

“连接器包 ”服务器版本旨在生成用于与 IBM 连接包集成的代码。 首先,使用 OASCreator Tool 为该服务器类型量身定制 OpenAPI 3.0 规范。 这种代码生成可以提供连接器应用生成所需的重要信息。 根据该规范,生成器可生成 FastAPI 后端和客户端 SDK 库,后者可处理与 IBM Connectivity Pack 端点的所有通信。

支持以下 IBM Connectivity Pack 应用程序:
  • Postgres
  • DynamoDB
  • Db2
  • Salesforce
  • ServiceNow
提示示例
Generate some Python FastAPI server for a connector based on the following openapi @<filename.yaml>

Generate some Python FastAPI server for a postgres connector based on the following openapi @<filename.yaml>

Generate some Python FastAPI server for a dynamodb connector based on the following openapi @<filename.yaml>

Generate some Python FastAPI server for a db2 connector based on the following openapi @<filename.yaml>

Generate some Python FastAPI server for a salesforce connector based on the following openapi @<filename.yaml>

Generate some Python FastAPI server for a servicenow connector based on the following openapi @<filename.yaml>
重要说明:
  1. 对于 API Agent 支持的应用程序,您必须携带自己的凭据,才能向所提供的 IBM Connectivity Pack 路由调用 API。 这些凭证必须输入到生成的 config.json 中。 不同应用程序的凭证设置各不相同。