Panenco papi
npm install @panenco/papi@panenco/papi is a superset on top of a few packages:
- routing-controllers
- class-validator
- class-transformer
This general set of utilities helps you to build RESTful APIs with ease.
It embraces a very opinionated approach by forcing a specific pattern. All endpoints using these utilities should follow the following steps:
1. Authorize and validate requirements
2. Validate and map input (body, query, params)
3. Business logic in a handler
4. Output representation with a specific schema defined in validation classes so no excessive data can be accidentally returned
4 Main categories of utilities:
- Decorators
- Authorization
- Contracts
- Middleware
A set of extended and combined decorators to make input validation and output representation easier and very consistent.
The full list of available decorators can be found in the technical documentation.
A general way of authorizing requests by first validating the token and then checking the authorization requirements specified in the route.
1. Create an authenticator instance and pass it to routing-controllers authorizationChecker with getAuthenticator
- This will connect the @Authorize decorator
2. Apply @Authorize decorator to a route or controller
3. Create a Requirement
4. Pass one or a set of requirements to the @Authorize decorator
- To see how the requirements are applied, see the authenticator documentation
Applications should use short lived JWT tokens to authenticate users.
papi uses a simple yet secure token mechanism. A secret is used to sign the token and the same secret is used to verify the validity of the token. Each application and environment should have it's own secret.
Creating a token is as simple as calling createAccessToken with the required data and the secret that's used when getting the authenticator.
When the @Authorize decorator fires the token will be automatically verified and the data will be available on request.token
Contracts are the way to validate input and output. All views and bodies should be a contract with properties appropriately decorated using class-validator and class-transformer decorators.
papi comes with a set of base contracts for error handling and pagination.
- Error classes
- Contract classes (Paging / Representation)
A set of default middleware is provided.
The full list of available middleware can be found in the technical documentation.
Helper functions that generate a swagger schema based on views annotated with class-validator and class-transformer. Except for some small fixes, this code is copied from epiphone/class-validator-jsonschema.
Tests are executed on a local build. Make sure the watcher is always on by enabling vscode > Manage Automatic Tasks in Folder > Allow Automatic Tasks in Folder