npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

egg-validate-middleware

v1.0.1

Published

JSON schema validator middleware for Egg.js

Downloads

8

Readme

egg-validate-middleware

NPM version build status Test coverage David deps Known Vulnerabilities npm download

JSON schema validator middleware for Egg.js.

Install

$ npm i egg-validate-middleware --save

Usage

// {app_root}/config/plugin.js
exports.validateMiddleware = {
  enable: true,
  package: 'egg-validate-middleware',
};

Configuration

// {app_root}/config/config.default.js
exports.validateMiddleware = {
    formatResponse: null
};

formatResponse is used to pack response's schema define to make sure all response data has same format. Only effective when schema had response define.

// response schema
const schema = {
  response: {
    type: 'string'
  }
}
// will allow response like { code: 200, message: 'message', data: 'response' }
formatResponse(responseSchema) {
  return {
    type: 'object',
    properties: {
      code: { type: 'number' },
      message: { type: 'string' },
      data: responseSchema,
    },
  };
}

see config/config.default.js for more detail.

Example

Define schema

All schemas must defined at app/schema, and will auto load to app.schema.

// app/schema/home.js
module.exports = {
  index: {
    // [option] Used to validte input params
    request: {
      query: {
        type: 'object',
        properties: {
          // query string params
        }
      },
      params: {
        type: 'object',
        properties: {
          // url params
        }
      },
      body: {
        // request body
      }
    },
    // [option] Used to format and fast stringify response data
    response: {
      type: 'object',
      properties: {
        // response format
      }
    }
  }
};

Schema and controller should be one-to-one correspondence.

// app/schema/home.js
module.exports = {
  index: {
    // ...
  }
};

// should match to

// app/controller/home.js
class HomeController extends Controller {
  async index() {
    // ...
  }
}

Use middleware

This middleware should be placed in front of the controller:

// app/router.js
module.exports = app => {
  const { router, controller, middleware, schema } = app;
  const { validate } = middleware;

  router.get('/home/index', validate({ schema: schema.home.index }), controller.home.index);
}

see test for more detail.

Questions & Suggestions

Please open an issue here.

License

MIT