Simplificando sus archivos OpenAPI con OpenAPI Trimmer

Administrar archivos OpenAPI de gran tamaño puede ser una molestia, especialmente cuando solo necesitas una pequeña parte de la API para tareas específicas. Aquí es donde OpenAPI Trimmer resulta útil. Es una herramienta liviana diseñada para recortar sus archivos OpenAPI para incluir solo los puntos finales y los objetos de transferencia de datos (DTO) que le interesan.

¿Cómo funciona?

Supongamos que está trabajando con un archivo OpenAPI grande, pero solo necesita los puntos finales relacionados con Quotes API. Puede extraer fácilmente solo esos puntos finales y eliminar DTO irrelevantes con un solo comando:

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

Este comando:

• -i openapi.yaml: utiliza tu archivo OpenAPI YAML existente como entrada.
• -p /v1/quotes,/v1/users: Mantenga solo los puntos finales que comiencen con /v1/quotes y /v1/users.
• -ec CompanyConfigDto,UpdateCompanyConfigDto: excluye componentes específicos, en este caso, CompanyConfigDto y UpdateCompanyConfigDto.

La definición de API recortada se guardará como openapi-trimmer.yaml.

Validación

Para garantizar la integridad de su archivo OpenAPI recortado, valídelo con:

swagger-cli validate ./openapi-trimmer.yaml

Este paso ayuda a detectar cualquier problema antes de implementar o compartir el archivo API recortado.

Instalación

Puedes instalar OpenAPI Trimmer directamente desde PyPi:

pip install openapi-trimmer

Para obtener más detalles y las últimas actualizaciones, visite la página OpenAPI Trimmer PyPi.

Repositorio de GitHub: OpenAPI Trimmer en GitHub.

Opciones de línea de comandos

OpenAPI Trimmer ofrece varias opciones para personalizar su funcionamiento:

• -h, --help: Muestra información de ayuda.
• -v, --version: muestra el número de versión.
• -i INPUT, --input INPUT: Especifique el archivo YAML de entrada (obligatorio).
• -o SALIDA, --output SALIDA: define el nombre del archivo de salida (opcional; de forma predeterminada, se agrega '-trimmed' al archivo de entrada).
• -p PREFIJOS, --prefixes PREFIJOS: enumera las rutas que se conservarán en la salida (separadas por comas).
• -ec EXCLUDE_COMPONENTS, --exclude-components EXCLUDE_COMPONENTS: enumera los componentes que se excluirán (separados por comas).

Conclusión

OpenAPI Trimmer es una herramienta esencial para los desarrolladores que buscan optimizar sus archivos OpenAPI, haciéndolos más manejables y adaptados a necesidades específicas. Ya sea que esté preparando documentación de API o simplificando una API para uso interno, OpenAPI Trimmer le ahorra tiempo y esfuerzo al centrarse solo en lo que más le importa.