{"id":18908954,"url":"https://github.com/luckcoding/koa-controller","last_synced_at":"2025-04-15T05:32:21.184Z","repository":{"id":41309026,"uuid":"232275064","full_name":"luckcoding/koa-controller","owner":"luckcoding","description":"整合koa-router、joi，采用注解方式开发业务逻辑，实现参数验证、中间件绑定、接口文档生成等功能。","archived":false,"fork":false,"pushed_at":"2022-12-22T14:40:27.000Z","size":364,"stargazers_count":5,"open_issues_count":2,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-10-13T11:43:43.533Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/luckcoding.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}},"created_at":"2020-01-07T08:07:19.000Z","updated_at":"2021-04-12T07:41:10.000Z","dependencies_parsed_at":"2023-01-30T11:45:46.110Z","dependency_job_id":null,"html_url":"https://github.com/luckcoding/koa-controller","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luckcoding%2Fkoa-controller","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luckcoding%2Fkoa-controller/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luckcoding%2Fkoa-controller/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luckcoding%2Fkoa-controller/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/luckcoding","download_url":"https://codeload.github.com/luckcoding/koa-controller/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223660928,"owners_count":17181578,"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":[],"created_at":"2024-11-08T09:29:48.705Z","updated_at":"2024-11-08T09:29:49.206Z","avatar_url":"https://github.com/luckcoding.png","language":"TypeScript","readme":"# @koa-lite/controller\n\n[![npm package](https://img.shields.io/npm/v/@koa-lite/controller/latest.svg)](https://www.npmjs.com/package/@koa-lite/controller)\n\n## install\n\n`$ yarn add @koa-lite/controller`\n\n## demo\n\n\u003e real demo: [hotchcms](https://github.com/luckcoding/hotchcms)\n\n* `$ npm install`\n* `$ npm start`\n\n## use\n\n```js\n// controller.ts\nimport { Prefix, Tag, Get, Summary, Query } from '@koa-lite/controller'\n@Prefix('/ucenter')\nexport default class User {\n  @Tag('User')\n  @Get('/user') // or request.get('/user'), request('get', '/user')\n  @Summary('User list')\n  @Query(Joi.object({\n    name: Joi.string().required().description('name'),\n  })) // check.query()\n  async sms(ctx: BaseContext) {\n    ctx.body = {}\n  }\n}\n\n// router.ts\nimport { Controller, InjectHandle } from '@koa-lite/controller'\nimport User from './controller.ts'\n\n// 包装函数\nInjectHandle(({ fn }) =\u003e fn)\n\nconst router = new Controller({\n  prefix: '/v1',\n  docs: {\n    title: '接口文档 - 客户端',\n    version: 'v1',\n    description: '业务接口文档 - by Hotchcms',\n    securities: [{\n      type: 'headers',\n      key: 'Authorization', // 自动注入token等信息\n      value: function (data) {\n        var ret = (data instanceof Object) \u0026\u0026 data.ret\n        return /^Bearer\\s/.test(ret) ? ret : ''\n      },\n    }, {\n      type: 'headers',\n      key: 'x-device-id',\n      value: '10001',\n    }],\n  }})\n  .controllers([ User ])\n  .get('/', ctx =\u003e { ctx.body = 'API V1' })\n\n// app.ts\napp.use(router.routes())\n```\n\n## api\n\n* `Prefix()`\n* `Get()`\n* `Post()`\n* `Put()`\n* `Delete()`\n* `Body`\n* `Query`\n* `Params`\n* `Headers`\n* `Middle([])`\n* `Summary()`\n* `Tag()`","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fluckcoding%2Fkoa-controller","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fluckcoding%2Fkoa-controller","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fluckcoding%2Fkoa-controller/lists"}