quickapi-cli
v2.0.0
Published
Esta librería se encargará de generar automáticamente clientes para consumir APIs a partir de descripciones como OpenAPI/Swagger o Postman.
Downloads
270
Maintainers
Readme
Quickapi-cli
quickapi-cli es una herramienta para generar automáticamente clientes que consumen APIs, a partir de descripciones en formatos como OpenAPI/Swagger o Postman Collection. Simplifica el proceso de interacción con APIs al crear automáticamente las funciones necesarias para realizar solicitudes HTTP.
Novedades en la versión 2.0.0
¡Nuevo! Se ha añadido soporte para generar código de cliente usando Fetch o Axios Esta funcionalidad es compatible con Postman Colletion y yaml.
El parametro --type dejo de ser necesario
npx quickapi --file api-spec.json --output ./client3 -client fetch
Instalación
Instala la librería globalmente para poder usarla como un comando en tu terminal:
npm install -g quickapi-cli
Puedes ejecutar la herramienta utilizando los comandos qapi o quickapi desde la terminal:
npx qapi --file api-spec.yaml --output ./client
npx quickapi --file api-spec.yaml
const { generateClient } = require('./quickapi');
generateClientFunction({ filePath:"./api-spec.yaml", client: "./api.js" })
Características principales:
- 🛠 Automatización: Genera funciones listas para usar basadas en especificaciones de API.
- ⚡ Eficiencia: Simplifica el consumo de APIs reduciendo tiempo y esfuerzo.
- 📚 Compatibilidad: Diseñado para adaptarse a tus necesidades de desarrollo en proyectos modernos. Beneficios:
Mejora la productividad al eliminar la necesidad de escribir clientes manualmente. Reduce errores al confiar en generación basada en estándares de API.
¡Lleva tus proyectos al siguiente nivel con quickapi-client! 🚀
Uso
Uso: quickapi-cli [opciones]
Opciones:
-h, --help Mostrar esta ayuda
-f, --file <file> Especificar el archivo de entrada (obligatorio)
-o, --output <path> Especificar la ruta de salida (default: ./quickapi.js)
-c, --client <client> Especificar el cliente a utilizar (default: axios, soporta axios, fetch)
Ejemplo: quickapi --file <path> [--output <path>] [--client <axios|fetch>]