Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/inaiat/fastify-papr
Fastify Papr plugin integration
https://github.com/inaiat/fastify-papr
Last synced: about 1 month ago
JSON representation
Fastify Papr plugin integration
- Host: GitHub
- URL: https://github.com/inaiat/fastify-papr
- Owner: inaiat
- Created: 2022-08-07T23:10:36.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-25T13:10:19.000Z (about 2 months ago)
- Last Synced: 2024-10-09T19:11:45.801Z (about 1 month ago)
- Language: TypeScript
- Size: 785 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# fastify-papr
   
A fastify Papr plugin integration.
## Getting started
```bash
yarn add @inaiat/fastify-papr @fastify/mongodb
```
Next, set up the plugin:
```ts
import fastifyMongodb from '@fastify/mongodb'
import fastifyPaprPlugin, { asCollection, FastifyPaprOptions } from ' @inaiat/fastify-papr'
import fp from 'fastify-plugin'
import { Model, schema, types } from 'papr'
const userSchema = schema({
name: types.string({ required: true, minLength: 10, maxLength: 100 }),
phone: types.string({ required: true, minLength: 8, maxLength: 20 }),
})
const userIndexes = [{ key: { name: 1 } }]
declare module '@inaiat/fastify-papr' {
interface FastifyPapr {
user: Model>
}
}
export default fp(
async (fastify) => {
await fastify.register(fastifyMongodb, {
url: 'mongodb://localhost:27017',
})
await fastify.register(fastifyPaprPlugin, {
db: fastify.mongo.client.db('test'),
models: {
user: asCollection('user', userSchema, userIndexes)
},
})
},
{ name: 'papr' },
)
```
How to use:
```ts
import { FastifyPluginAsync } from 'fastify'
import { Static, Type } from '@sinclair/typebox'
const userDto = Type.Object({
name: Type.String({ maxLength: 100, minLength: 10 }),
phone: Type.String({ maxLength: 20, minLength: 8 }),
})
const userRoute: FastifyPluginAsync = async (fastify) => {
fastify.post<{ readonly Body: Static }>(
'/user',
{
schema: {
body: userDto,
},
},
async (req) => {
const result = await fastify.papr.user.insertOne(req.body)
return result
},
)
}
export default userRoute
```
## Papr Documentation and examples
To learn more about the code and see additional examples, you can visit the Papr documentation at [plexinc.github.io/papr](https://plexinc.github.io/papr/) and explore test folder on this project.