api doc gpt

API 文档 GPT

这是一个 AI 工具，可以帮助您发现 API 文档。它基于 OpenAI 的 GPT-3.5 语言模型。您可以通过直接连接到 FastApi 应用程序或传入openapi.json文件来使用它。

设置

安装依赖项

pip install -r requirements.txt

如何与 FastApi 一起使用

1. 运行您的后端应用程序

uvicorn main:app --reload

2. 运行脚本

python api_master.py --openai-key < your-openai-key > --target < your-fastapi-app > --base-url < your-base-url > 

如何与 openapi.json 一起使用

python api_master.py --openai-key < your-openai-key > --openapi-json < openapi-json > --base-url < your-base-url > 

运行示例

python api_master.py --openai-key= < your-openai-key > --openapi-json=./example/openapi.json --base-url= " https://petstore3.swagger.io/api/v3 "

享受与 API 文档交互的乐趣

与 GPT-4

这也适用于 GPT-4。您只需在运行脚本时传递参数--model-name=gpt-4即可。

它是如何运作的

这是通过从 fastapi 应用程序创建开放 api 文档，然后使用 GPT-3.5 语言模型来分析 API 文档来实现的。

序列图
    用户-->>+处理器：给我一个项目列表。我只需要 5 个
    处理器-->>+AI：提示：给我一份项目清单。我只需要 5 个
    AI-->>+处理器：CMD：GET /items?filter=5
    处理器-->>+AI: CMD_RESP: [{"name": "cucumber"}, {"name": "celery"}...]
    AI-->>+处理器：OUT：物品是黄瓜、芹菜……
    处理器-->>+用户：物品是黄瓜、芹菜......

这也支持react。更多详细信息请参见：https://arxiv.org/abs/2210.03629

约束条件

• 代币大小