{"id":14989575,"url":"https://github.com/peakchen90/koa-params-validator","last_synced_at":"2026-01-04T06:47:35.058Z","repository":{"id":96138200,"uuid":"146168428","full_name":"peakchen90/koa-params-validator","owner":"peakchen90","description":"Koa2  请求参数校验","archived":false,"fork":false,"pushed_at":"2019-05-12T09:15:27.000Z","size":93,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-03-18T15:09:42.098Z","etag":null,"topics":["koa","koa-middleware","koa-validator","koa2","object-validator","request-validation"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/koa-params-validator","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/peakchen90.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-08-26T09:41:00.000Z","updated_at":"2019-05-30T01:32:25.000Z","dependencies_parsed_at":"2023-03-13T16:37:40.218Z","dependency_job_id":null,"html_url":"https://github.com/peakchen90/koa-params-validator","commit_stats":{"total_commits":10,"total_committers":2,"mean_commits":5.0,"dds":0.09999999999999998,"last_synced_commit":"77b5e8cac6fac04003ceef10d0ad388e3d4f0d73"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peakchen90%2Fkoa-params-validator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peakchen90%2Fkoa-params-validator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peakchen90%2Fkoa-params-validator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peakchen90%2Fkoa-params-validator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/peakchen90","download_url":"https://codeload.github.com/peakchen90/koa-params-validator/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244875047,"owners_count":20524591,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["koa","koa-middleware","koa-validator","koa2","object-validator","request-validation"],"created_at":"2024-09-24T14:18:35.671Z","updated_at":"2026-01-04T06:47:34.902Z","avatar_url":"https://github.com/peakchen90.png","language":"JavaScript","readme":"# koa-params-validator\nKoa2 请求参数校验中间件, 基于 [easy-object-validator](https://github.com/peakchen90/easy-object-validator) 校验\n\n[![Build Status](https://travis-ci.org/peakchen90/koa-params-validator.svg?branch=master)](https://travis-ci.org/peakchen90/koa-params-validator)\n[![Codecov](https://img.shields.io/codecov/c/github/peakchen90/koa-params-validator.svg)](https://codecov.io/gh/peakchen90/koa-params-validator)\n[![npm](https://img.shields.io/npm/v/koa-params-validator.svg)](https://www.npmjs.com/package/koa-params-validator)\n[![npm](https://img.shields.io/npm/dt/koa-params-validator.svg)](https://www.npmjs.com/package/koa-params-validator)\n[![GitHub](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/peakchen90/koa-params-validator/blob/master/LICENSE)\n\n\n## 安装\n```bash\nnpm i -S koa-params-validator\n```\n\n## 环境要求\n- Node \u003e= 7.6\n- Koa \u003e= 2.0\n\n## 快速开始\n```js\nconst validator = require('koa-params-validator')\nconst app = new require('koa')();\n\n// validator() 返回一个Koa2中间件方法，未通过校验的将返回 500 状态码\napp.use(validator({\n  query: {\n    keyword: validator.string().isRequire()\n  },\n  body: {\n    data: validator.arrayOf(validator.object())\n  }\n}))\n\n// 在路由中使用\nroute.post('/login', validator({\n  body: {\n    username: validator.string().isRequire()\n    password: validator.string().isRequire()\n  }\n}, {\n  statsu: 200,\n  state:{\n    success: false,\n    data: '用户名或密码不能为空'\n  }\n}), (ctx) =\u003e {\n  // login...\n})\n```\n\n## API\n\u003e 校验规则的API与 [easy-object-validator](https://github.com/peakchen90/easy-object-validator) 完全一致，请直接参考其用法\n\n### **`validator`: Function(options, invalidMixinContext)**\n  - {Object} `options` 校验规则，请参考 [easy-object-validator](https://github.com/peakchen90/easy-object-validator)\n  - {Object} `invalidMixinContext` [可选] 未通过校验时将这个对象混合到Koa的context对象上，默认 status: 500, 默认 message: 'The parameter is invalid'\n  - 返回一个Koa中间件\n\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpeakchen90%2Fkoa-params-validator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpeakchen90%2Fkoa-params-validator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpeakchen90%2Fkoa-params-validator/lists"}