Contrato OpenAPI | Documentação da Raims

O repositório raimshq/openapi publica o contrato OpenAPI da versão da API Raims disponível para integrações. Use esse contrato para consultar a estrutura dos endpoints, importar a referência em uma ferramenta compatível ou gerar um cliente para o seu projeto.

O diretório latest acompanha a versão efetivamente publicada da API. Ele não antecipa mudanças que ainda estejam somente no código-fonte.

Arquivos disponíveis

JSON
YAML

Os dois arquivos descrevem o mesmo contrato. Escolha o formato aceito pela sua ferramenta.

Baixar ou importar

Para baixar o JSON:

Shell

curl --fail --location --output openapi.spec3.json https://raw.githubusercontent.com/raimshq/openapi/main/latest/openapi.spec3.json

No Postman, Insomnia ou outra ferramenta compatível com OpenAPI 3, escolha a importação por URL e informe o endereço do arquivo JSON ou YAML. Se a ferramenta aceitar somente arquivos locais, baixe um deles e faça a importação pelo disco.

O contrato descreve a autenticação Bearer, mas não contém credenciais. Configure sua chave no ambiente seguro da ferramenta e não a grave na coleção exportada.

Gerar um cliente

Use o arquivo baixado como entrada de um gerador compatível com OpenAPI 3. Por exemplo, com o OpenAPI Generator CLI:

Shell

openapi-generator-cli generate \
  -i openapi.spec3.json \
  -g SEU_GERADOR \
  -o ./generated/raims

Escolha o gerador da linguagem e da biblioteca usadas no seu projeto. Revise o código gerado, mantenha a configuração do gerador versionada e execute os testes da integração antes de atualizar sua aplicação. Esse cliente pertence ao seu projeto e não é um SDK oficial da Raims.

Manter o contrato atualizado

Use os endereços de main/latest desta página para baixar o contrato atual, inclusive em geração de código e CI. Baixe o arquivo novamente antes de gerar o cliente para acompanhar a versão publicada da API.

Revise as diferenças do contrato, regenere o cliente e execute os testes da integração antes de atualizar sua aplicação. Um novo download não altera automaticamente o código já gerado no seu projeto.