It's the NestJS superset of
tectonique/api-standards
🌩 API Standards – NestJS
This library is based on tectonique/api-standards
It implements its Envelope and ProblemDetail schema for NestJS applications.
Additionally, this library provides low barrier validation mechanisms powered by Zod
📖 Table of contents
🌩 API Standards – NestJS📖 Table of contents📦 NPM Package💾 Installation🏁 Goal-
📑 Documentation 📜 Changelog🦔 Author
📦 NPM Package
💾 Installation
Using npm:
npm i @tectonique/api-standards-nestjs
Using yarn:
yarn add @tectonique/api-standards-nestjs
To install all components use useApiStandards(app)
:
import { useApiStandards } from '@tectonique/api-standards-nestjs';
async function bootstrap() {
const app = await NestFactory.create(AppModule);
// Register all NestJS API standards components.
useApiStandards(app, () => {
return InternalServerProblemDetail();
});
await app.listen(8080);
}
bootstrap();
🏁 Goal
The goal of the library is to help you create:
- NestJS APIs with validated incoming data (query params, request bodies)
- a scalable and type safe error handling system
- 100% type safe API calls
Check out the following examples:
- Frontend: 100% type safe api calls thanks to envelopes
- Backend: Validated query parameters
- Backend: Validated request bodies
- Backend: Sanitized endpoint responses
📑 Documentation
📨 Envelopes and ⚠️ Problem Details
💎 Zod powered data validation and transformation
📜 Changelog
🦔 Author
Peter Kuhmann
GitHub: hedgehogs-mind
Tectonique