@thequinndev/route-manager
v0.0.1-alpha.3
Published
<a><img src="https://img.shields.io/badge/created%[email protected]" alt="Created by @thequinndev"></a> <hr />
Maintainers
Readme
Route Manager
Endpoint management, OpenAPI management and auto-documentation in one simple module.
Simple endpoint management using zod
import { RouteManager } from '@thequinndev/route-manager'
const routeManager = RouteManager()
// READ
const getUser = routeManager.endpoint({
operationId: 'getUser',
path: '/users/:userId',
method: 'get',
accepts: {
path: z.object({
userId: z.number()
})
},
returns: {
200: z.object({
output: z.string()
}),
400: z.object({
message: z.string()
}).array(),
404: z.object({
message: z.string()
}).array(),
500: z.enum(['Internal Server Error'])
}
})
// CREATE
const createUser = routeManager.endpoint({...})
// UPDATE
const updateUser = routeManager.endpoint({...})
// DELETE
const deleteUser = routeManager.endpoint({...})
// Group endpoints by entity or purpose
const userEndpoints = routeManager.endpointGroup([
getUser,
createUser,
updateUser,
deleteUser
])
...- For more, see the Route Manager Documentation
