Giter Club home page Giter Club logo

next-with-zod-schema's Introduction

Validate API Requests in NextJS before they reach you

The basis is the validation library zod .

withSchema works both with GET and POST requests so you don't have to worry about query vs body params. This library detects the mode and will always validate the correct one.

Usage

  • npm i zod && npm i next-with-zod-schema
  • Go to your api/ file in Next e.g. api/test.js

Do this (default is POST):

const BODY_SCHEMA = z.object({
  email: z.string().email(),
  type: z.enum(["normal", "unnormal"]),
});

export default withSchema(
  BODY_SCHEMA,
  async function YourApiRoute(req, res, body) {
    // if you reach this point the body data is already validated and it's also perfectly typed for TypeScript!

    console.log("the email was perfect", body.email);
    console.log("The type was perfect as well", body.type);
  }
);

Usage with GET

export default withSchema(BODY_SCHEMA, YOUR_FUNCTION, "GET");

next-with-zod-schema's People

Contributors

activenode avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.