Herramienta para crear un SDK de TypeScript y un simulador de mocks a partir de un archivo Swagger.json
El SDK (Software Development Kit) aquí incluye las siguientes funciones:
- colección de funciones
fetch - estructuras DTO
- simulador de mocks
Al compilar y usar el SDK, para los desarrolladores frontend (cliente) es mucho más simple y seguro que leer la documentación de Swagger y volver a escribir las funciones fetch y los tipos DTO; además, también automatiza el trabajo de hacer mocking del servidor backend con msw, lo que aumenta la productividad.
6 comentarios
Buen artículo, gracias por el enfoque interesante. Puede que sea solo una preferencia personal, pero me habría gustado que en la parte principal del texto hubiera ejemplos del tipo: "si pones este código, algo que antes funcionaba así, ahora pasa a funcionar de esta otra manera". Tal como está ahora, el texto principal casi no me atrae visualmente.
¿En el ecosistema de TS es común definir manualmente los tipos y funciones relacionados basándose en la documentación?
Relacionado con esto, existe una biblioteca llamada Tspec que genera automáticamente la especificación OpenAPI a partir de tipos de TypeScript jaja
https://github.com/ts-spec/tspec
En TS, el código que genera openapi-generator no resulta muy útil.
De todos modos, parece más bien una guía de uso de una herramienta creada directamente por samchon, quien publicó este artículo, así que también da la impresión de que debería ir más hacia la sección Show GN.
En cualquier caso, me parece una buena idea eso de usar el archivo
swagger.jsonpara habilitar el autocompletado en un cliente de TypeScript. ¿Se puede usar también con otros stacks de backend además de NestJS?No importa el lenguaje o framework, basta con poder generar el
swagger.jsondel spec OpenAPI v3.0.Antes también había publicado un post del blog con la etiqueta show GN, pero en ese momento el administrador me dijo que show GN es un lugar donde solo se publican enlaces de GitHub o del proyecto, así que lo movió a una publicación general.