Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/danybeltran/serverless-request-validator
Validate requests made to a Vercel serverless application in an Express-like way
https://github.com/danybeltran/serverless-request-validator
api api-validator backend serveless
Last synced: 20 days ago
JSON representation
Validate requests made to a Vercel serverless application in an Express-like way
- Host: GitHub
- URL: https://github.com/danybeltran/serverless-request-validator
- Owner: danybeltran
- License: mit
- Created: 2021-02-13T19:41:52.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-02-16T07:43:21.000Z (almost 4 years ago)
- Last Synced: 2024-12-27T15:27:33.262Z (29 days ago)
- Topics: api, api-validator, backend, serveless
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/serverless-request-validator
- Size: 20.5 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Serverless request validator
This is made to be used in Vercel serverless applications, it can be used with Javascript and Typescript.
To install it:
```sh
npm install serverless-request-validator
```
or
```
yarn add serverless-request-validator
```
## Using the library
If you are using Javascript:
```js
const Validate = require("serverless-request-validator");
```
With Typescript:
```ts
import Validate from "serverless-request-validator";
```
#### Handling one-method-only requests
If an endpoint in your app should only accept one HTTP method, use the property named as the only method allowed.
For example:
**Javascript**
```js
// /api/index.js
const Validate = require("serverless-request-validator")
// Only HTTP `GET` is allowed
module.exports = Validator.get((req, res)=>{
res.send("get request")
})
```
**Typescript**
```ts
// /api/index.ts
import Validate from "serverless-request-validator";
// Only HTTP `GET` is allowed
export default Validate.get((req, res)=>{
res.send("get request")
})
```
> The default export means that the application endpoint will only allow a request using the `GET` method.
> If a request is made using a different method, it will respond with a `405` (method not allowed) status code, and saying the method can't be used in that url (like in Express)
#### Handling multi-method requests
This makes it possible for an endpoint to handle requests of different methods. Very similar to the previous example:
**Javascript**
```js
// /api/index.js
const Validate = require("serverless-request-validator")
// GET, POST and PUT are allowed.
module.exports = Validate({
get(req, res) {
res.send("a get request");
},
post(req, res) {
res.send(`A ${req.method} request`);
},
put(req, res) {
res.send("a put request");
},
})
```
**Typescript**
```ts
// /api/index.ts
import Validate from "serverless-request-validator";
// GET, POST and PUT are allowed
export default Validate({
get(req, res) {
res.send("Hello");
},
post(req, res) {
res.send(`A ${req.method} request`);
},
put(req, res) {
res.send("a PUT request");
},
})
```
> In this case, this function will handle `GET`,`POST` and `PUT` methods sent to it.
> As in the previous example, other methods different that the allowed ones will send a `405` status code and the message saying the method can't be used in that url.
#### Sending files
It is possible to use the `sendFile()` method available
```ts
// /api/index.ts
import Validate from "serverless-request-validator";
import path from "path"
export default Validate.get((req,res)=>{
res.sendFile(path.resolve(__dirname,"../src/cat.png"))
})
```
> If a file doesn't exist, a 404 status code will be sent to the user
That's basically it, hopefuly it makes it easier to have different reponses for different methods=)