https://github.com/foodsy-app/fastify-typebox
Plugin for Fastify to prevent having to write duplicate type definitions for schemas.
https://github.com/foodsy-app/fastify-typebox
fastify fastify-plugin json-schema typebox
Last synced: about 1 month ago
JSON representation
Plugin for Fastify to prevent having to write duplicate type definitions for schemas.
- Host: GitHub
- URL: https://github.com/foodsy-app/fastify-typebox
- Owner: foodsy-app
- License: mit
- Created: 2020-07-21T07:07:56.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-03-28T15:46:12.000Z (about 4 years ago)
- Last Synced: 2025-05-03T11:01:47.802Z (about 2 months ago)
- Topics: fastify, fastify-plugin, json-schema, typebox
- Language: TypeScript
- Homepage:
- Size: 83 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @foodsy-app/fastify-typebox
Plugin for Fastify to prevent having to write duplicate type definitions for schemas.
`@foodsy-app/fastify-typebox` uses [typebox](https://github.com/sinclairzx81/typebox), to compose JSON schemas.
## Important note before using this plugin!
This plugin requires [patch-package](https://www.npmjs.com/package/patch-package) to comment existing type declarations for request methods in `node_modules/fastify/types/instance.d.ts` since TypeScript does not allow to overwrite declarations.
Create a `fastify+3.1.1.patch` file (edit the version based on the Fastify version you have installed) and paste the block below inside:
```diff
diff --git a/node_modules/fastify/types/instance.d.ts b/node_modules/fastify/types/instance.d.ts
index 06380bd..558338d 100644
--- a/node_modules/fastify/types/instance.d.ts
+++ b/node_modules/fastify/types/instance.d.ts
@@ -66,14 +66,14 @@ export interface FastifyInstance<
ContextConfig = ContextConfigDefault
>(opts: RouteOptions): FastifyInstance;
- get: RouteShorthandMethod;
- head: RouteShorthandMethod;
- post: RouteShorthandMethod;
- put: RouteShorthandMethod;
- delete: RouteShorthandMethod;
- options: RouteShorthandMethod;
- patch: RouteShorthandMethod;
- all: RouteShorthandMethod;
+ // get: RouteShorthandMethod;
+ // head: RouteShorthandMethod;
+ // post: RouteShorthandMethod;
+ // put: RouteShorthandMethod;
+ // delete: RouteShorthandMethod;
+ // options: RouteShorthandMethod;
+ // patch: RouteShorthandMethod;
+ // all: RouteShorthandMethod;
// addHook: overloads
```
After this, run the following command:
```bash
npx patch-package --patch-dir .
```
Run the same command using the `--reverse` flag if you notice any problems.
## Tip
Add the patch file to your source control and add the script below to the scripts section in your `package.json` so that people who install your project do not have to manually apply the patch:
```json
"scripts": {
"postinstall": "npx patch-package --patch-dir ."
}
```
## Install
```bash
npm i @foodsy-app/fastify-typebox @sinclair/typebox
# Or if you are using Yarn
yarn add @foodsy-app/fastify-typebox @sinclair/typebox
```
## Usage
Add it to your project using `register` and you are done!
```typescript
import fastify from "fastify";
fastify.register(require("@foodsy-app/fastify-typebox"));
```
## Examples
This plugin exposes a new method on the `FastifyInstance` called `typeboxSchema`
### Basic usage
**Notice**: Please refer to the [typebox repository](https://github.com/sinclairzx81/typebox) for a overview of the typebox API.
```typescript
import { Type } from "@sinclair/typebox";
// Available request methods are
// .get, .head, .post, .put, .delete, .options, .patch and .all
server.get(
"/secret-route/:id",
{
schema: server.typeboxSchema({
// You can also type querystring, headers and response
params: Type.Object({
id: Type.String(),
}),
body: Type.Object({
user: Type.Object({
name: Type.String(),
age: Type.Number({ minimum: 18 }),
}),
}),
}),
},
(request, reply) => {
// `id` is inferred as string
const id = request.params.id;
// `user` is inferred as the object we described!
const user = request.body.user;
}
);
```