api doc gpt

API-Dokument GPT

Dies ist ein KI-Tool, das Ihnen hilft, Ihre API-Dokumentation zu entdecken. Es basiert auf dem GPT-3.5-Sprachmodell von OpenAI. Sie können dies verwenden, indem Sie entweder eine direkte Verbindung zu einer FastApi-App herstellen oder eine openapi.json Datei übergeben.

Aufstellen

Installieren Sie die Abhängigkeiten

pip install -r requirements.txt

Verwendung mit FastApi

1. Führen Sie Ihre Backend-App aus

uvicorn main:app --reload

2. Führen Sie das Skript aus

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

Verwendung mit openapi.json

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

Laufbeispiel

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

Viel Spaß bei der Interaktion mit Ihrer API-Dokumentation

Mit GPT-4

Dies funktioniert auch mit GPT-4. Sie müssen beim Ausführen des Skripts lediglich den Parameter --model-name=gpt-4 übergeben.

Wie es funktioniert

Dies funktioniert, indem Sie eine offene API-Dokumentation aus Ihrer Fastapi-App erstellen und dann das GPT-3.5-Sprachmodell verwenden, um die Dokumentation für Ihre API zu analysieren.

 Sequenzdiagramm
    Benutzer-->>+Prozessor: Geben Sie mir eine Liste der Elemente. Ich brauche nur 5 davon
    Prozessor-->>+AI: PROMPT: Geben Sie mir eine Liste der Elemente. Ich brauche nur 5 davon
    AI-->>+Prozessor: CMD: GET /items?filter=5
    Prozessor-->>+AI: CMD_RESP: [{"name": "gurke"}, {"name": "sellerie"}...]
    AI-->>+Prozessor: OUT: Elemente sind Gurke, Sellerie ...
    Prozessor-->>+Benutzer: Elemente sind Gurke, Sellerie ...

Dies unterstützt auch React. Weitere Einzelheiten finden Sie unter: https://arxiv.org/abs/2210.03629

Einschränkungen

• Tokengröße