api doc gpt

Documento API GPT

Esta é uma ferramenta de IA que ajuda você a descobrir a documentação da sua API. É baseado no modelo de linguagem GPT-3.5 da OpenAI. Você pode usar isso conectando-se diretamente a um aplicativo FastApi ou passando um arquivo openapi.json .

Configurar

Instale as dependências

pip install -r requirements.txt

Como usar com FastApi

1. Execute seu aplicativo de back-end

uvicorn main:app --reload

2. Execute o script

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

Como usar com openapi.json

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

Exemplo de execução

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

Aproveite a interação com a documentação da sua API

Com GPT-4

Isso também funciona com GPT-4. Você só precisa passar o parâmetro --model-name=gpt-4 ao executar o script.

Como funciona

Isso funciona criando documentação de API aberta a partir de seu aplicativo fastapi e, em seguida, usando o modelo de linguagem GPT-3.5 para analisar a documentação de sua API.

 diagrama de sequência
    Usuário -->>+Processador: Dê-me uma lista de itens. só preciso de 5 deles
    Processador-->>+AI: PROMPT: Dê-me uma lista de itens. só preciso de 5 deles
    AI-->>+Processador: CMD: GET /items?filter=5
    Processador-->>+AI: CMD_RESP: [{"nome": "pepino"}, {"nome": "aipo"}...]
    AI-->>+Processador: FORA: Os itens são pepino, aipo...
    Processador-->>+Usuário: Os itens são pepino, aipo...

Isso também suporta reação. Mais detalhes podem ser encontrados em: https://arxiv.org/abs/2210.03629

Restrições

• Tamanho do token