# next-api-validation

> Request validator implemented in Next.js:)

Latest version **1.0.5** (published 2022-12-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install next-api-validation
pnpm add next-api-validation
yarn add next-api-validation
bun add next-api-validation
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.5 |
| Published | 2022-12-13 |
| First published | 2021-02-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 10.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Author | Dany Beltran |
| Maintainers | danybeltran |
| Keywords | next api validation, next api, api validation, next api handler |

## Links

- npm: https://www.npmjs.com/package/next-api-validation
- Repository: https://github.com/danybeltran/next-api-validation
- Homepage: https://github.com/danybeltran/next-api-validation#readme
- Issues: https://github.com/danybeltran/next-api-validation/issues
- npm.io page: https://npm.io/package/next-api-validation

## Dependencies (1)

- [mime-types](https://npm.io/package/mime-types.md) ^2.1.35

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 1.0.5 (latest) — 2022-12-13
- 1.0.4 — 2021-02-24
- 1.0.3 — 2021-02-24
- 1.0.2 — 2021-02-24
- 1.0.1 — 2021-02-24
- 1.0.0 — 2021-02-24

## README

###  Next API Validation

This is basically the same as [serverless-request-validator](https://www.npmjs.com/package/serverless-request-validator) ready be used in Next.js

### How to use it:

It is nice to be able to programmatically define what you want your API endpoint(s) to do deppending on the request method used.

In express it's something like:

```js
app.get((req,res)=>{
    res.send("Something");
})
```
> That will work only when using a `GET` request

In Next.js (and Vercel) apps, your API are files in a specific order in the project directory, each file with a default export being the actual handler that will handle that request.

First, install the module:

```sh
npm install next-api-validation
```
Or
```sh
yarn add next-api-validation
```

Using it in any of your API routes in Next.js:

```js
import validation from "next-api-validation";

export default validation.get((req,res)=>{
    res.send("This only accepts GET request")
})
```
> As you can see, using the `get` method in the `validation` object prevents the handler from being executed if a different request method is used.

And so with other methods:


```js
// api/index.js or api/index.ts
import validation from "next-api-validation";

export default validation.post((req,res)=>{
    res.send("You just sent a POST request")
})
```
> This handler a POST request

**What if an endpoint should handle requests using more than one or two methods?**

Creating a default export of the function should solve that:

```js
// api/index.js or api/index.ts
import validate from "next-api-validation"

export default validate({
    get(req,res){
        res.send("A get request")
    },
    post(req,res){
        res.send("I only handle post requests"))
    },
    put(req,res){
        res.send("Did you put something?")
    }
})
```

The previous code handles requests that use three different methods, and calls only the necessary handler. An example of how it can be used:

```js
// CRUD of a MongoDB Document model

import { Post } from "src/Models";
import { connectToDatabase } from "src/utils";
import validate from "next-api-validation";

connectToDatabase();

export default validate({
  get: async (req, res) => {
    const posts = await Post.find();
    res.send(posts);
  },
  post: async (req, res) => {
    const newPost = new Post(req.body);
    const saved = await newPost.save();
    res.send(saved);
  },
  put: async (req, res) => {
    const editedPost = await Post.findByIdAndUpdate(req.body._id, req.body);
    res.send(editedPost);
  },
  delete: async (req, res) => {
    const deletedPost = await Post.findByIdAndDelete(req.body._id);
    res.send(deletedPost);
  },
});
```

---
_Source: https://npm.io/package/next-api-validation · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._