Traducción de la página original en inglés. Si algo no cuadra, prevalece la versión en inglés.
Tutorial: crea la API de una librería
Vamos a construir de principio a fin un pequeño servicio para una librería: rutas, validación, seguridad, OpenAPI, un SDK tipado con Hey API y pruebas de contrato. Al terminar tendrás una aplicación DaloyJS con forma de producción.
- 01Crear el proyectopnpm add @daloyjs/core zod
- 02Fábrica buildApprutas · Zod · hooks de seguridad
- 03Servirserve(app) en Node
- 04Especificación OpenAPIgenerateOpenAPI(app)
- 05SDK tipadoHey API openapi-ts
- 06Pruebas de contratorunContractTests(app)
1. Crea el proyecto
2. Crea una fábrica buildApp compartida
Comparte la App entre el servidor, la generación de código y las pruebas para que la especificación, el cliente y las pruebas sigan alineados:
3. Arranca el servidor
4. Genera la especificación OpenAPI
5. Genera un SDK tipado con Hey API
6. Usa el SDK desde cualquier consumidor en TS
7. Añade pruebas
Lo que has construido
- Una API HTTP tipada, validada y protegida.
- Un documento OpenAPI 3.1 real y un SDK tipado generado, ambos sincronizados.
- Pruebas de contrato que vigilan las discrepancias en la CI.
- Un proceso de instalación reforzado con pnpm y un
.npmrccerrado a cal y canto.
Sigue con la guía de Seguridad, o con el tutorial de autorización multiusuario, Adapters o la referencia de la API, estos tres en inglés.
Última actualización: