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

express-magic-route

v3.0.0

Published

* 多URL配置 * API json schema 验证([email protected]) * 多中间件配置

Downloads

5

Readme

express 4.x 路由魔法配置器


快速使用

var express = require('express')
var magicRoute = require('express-magic-route')

var v1RouteConfig = require('./router/seedConfig')

var app = express()

app.use('/v1', magicRoute(v1RouteConfig))

配置文件参数

url
    string                      单个url路径
    [string]                    多个url路径使用相同的处理方式

method
    string                      方法,默认get

middleware
    function(req, res, next)    单个中间件处理该url/[url]
    [function(req, res, next)]  多个中间件按照顺序处理url/[url]
   
schema                          验证表单的schema
    function(req, joi)          joi数据验证,验证错误时返回http 400错误
                                验证失败时返回{error_no, error_desc}

where                           验证表单的schema req的属性
    string                      [query, body] 默认query

disable                         是否停用路由
    boolean                     默认为false

errorCode
    number                      验证数据错误码,默认-10001

使用事例 seedConfig.js

user = require('../middleware/user')

module.exports = [
  { // 登录时验证用户密码是否为空
    url: '/api/user/login'
    middleware: user.login
    schema: (req, Joi)->
      Joi.object({
        username: Joi.string().required()
        password: Joi.string().required()
      })
  }, {  // 登出时使用多中间件
    url: '/api/user/logout'
    middleware: [user.isValid, user.logout]
  }, {  // 多个url支持获取登录用户信息
    url: ['/api/user/profile', '/api/user/info']
    middleware: [user.isValid, user.get]
  }
]

错误格式化

var magicRoute = require('express-magic-route')

默认返回格式
{
  error_no: -100001
  error_desc: ''
}

// 可自己定制错误格式
magicRoute.ErrorFormater = function (code, error) {
  return code + error.desc
}

错误信息格式化
code: 默认错误代码
error: Joi错误对象