Перевод страницы с английского оригинала. При расхождениях приоритет имеет английская версия.
Руководство: API книжного магазина
Мы от начала до конца соберём небольшой сервис книжного магазина: маршруты, валидацию, защиту, OpenAPI, типизированный SDK на Hey API и контрактные тесты. В итоге у вас будет приложение DaloyJS, устроенное как настоящий продакшен.
- 01Создать проектpnpm add @daloyjs/core zod
- 02Фабрика buildAppмаршруты · Zod · хуки безопасности
- 03Запускserve(app) на Node
- 04Спецификация OpenAPIgenerateOpenAPI(app)
- 05Типизированный SDKHey API openapi-ts
- 06Контрактные тестыrunContractTests(app)
1. Создайте проект
2. Создайте общую фабрику buildApp
Используйте один App в сервере, кодогенерации и тестах, чтобы спецификация, клиент и тесты оставались согласованными:
3. Запустите сервер
4. Сгенерируйте спецификацию OpenAPI
5. Сгенерируйте типизированный SDK через Hey API
6. Используйте SDK в любом TS-потребителе
7. Добавьте тесты
Что у вас получилось
- Типизированный, валидируемый и защищённый HTTP API.
- Настоящий документ OpenAPI 3.1 и сгенерированный типизированный SDK, которые остаются синхронными.
- Контрактные тесты, защищающие от расхождений в CI.
- Усиленный процесс установки на pnpm и строгий
.npmrc.
Продолжите с раздела Безопасность, руководства по многопользовательской авторизации, Adapters или справочника API (последние три на английском).
Последнее обновление: