Simplificando seus arquivos OpenAPI com OpenAPI Trimmer

Gerenciar arquivos OpenAPI grandes pode ser um incômodo, especialmente quando você precisa apenas de uma pequena parte da API para tarefas específicas. É aqui que o OpenAPI Trimmer se torna útil. É uma ferramenta leve projetada para reduzir seus arquivos OpenAPI para incluir apenas os endpoints e objetos de transferência de dados (DTOs) de seu interesse.

Como funciona?

Digamos que você esteja trabalhando com um arquivo OpenAPI grande, mas só precisa dos endpoints relacionados à API de cotações. Você pode extrair facilmente apenas esses endpoints e remover DTOs irrelevantes com um único comando:

openapi-trimmer -i openapi.yaml \
  -p /v1/quotes,/v1/users \
  -ec CompanyConfigDto,UpdateCompanyConfigDto

Este comando irá:

• -i openapi.yaml: Use seu arquivo OpenAPI YAML existente como entrada.
• -p /v1/quotes,/v1/users: Mantenha apenas os endpoints começando com /v1/quotes e /v1/users.
• -ec CompanyConfigDto,UpdateCompanyConfigDto: Exclua componentes específicos, neste caso, CompanyConfigDto e UpdateCompanyConfigDto.

A definição da API cortada será salva como openapi-trimmer.yaml.

Validação

Para garantir a integridade do seu arquivo OpenAPI cortado, valide-o com:

swagger-cli validate ./openapi-trimmer.yaml

Esta etapa ajuda a detectar quaisquer problemas antes de implantar ou compartilhar o arquivo API cortado.

Instalação

Você pode instalar o OpenAPI Trimmer diretamente do PyPi:

pip install openapi-trimmer

Para obter mais detalhes e as atualizações mais recentes, visite a página OpenAPI Trimmer PyPi.

Repositório GitHub: OpenAPI Trimmer no GitHub.

Opções de linha de comando

O OpenAPI Trimmer oferece diversas opções para personalizar seu funcionamento:

• -h, --help: mostra informações de ajuda.
• -v, --version: exibe o número da versão.
• -i INPUT, --input INPUT: Especifique o arquivo YAML de entrada (obrigatório).
• -o OUTPUT, --output OUTPUT: Define o nome do arquivo de saída (opcional; o padrão é anexar '-trimmed' ao arquivo de entrada).
• -p PREFIXES, --prefixes PREFIXES: Lista os caminhos a serem retidos na saída (separados por vírgula).
• -ec EXCLUDE_COMPONENTS, --exclude-components EXCLUDE_COMPONENTS: lista os componentes a serem excluídos (separados por vírgula).

Conclusão

OpenAPI Trimmer é uma ferramenta essencial para desenvolvedores que buscam agilizar seus arquivos OpenAPI, tornando-os mais gerenciáveis ​​e adaptados a necessidades específicas. Esteja você preparando a documentação da API ou simplificando uma API para uso interno, o OpenAPI Trimmer economiza tempo e esforço, concentrando-se apenas no que é mais importante para você.