{"id":20373892,"url":"https://github.com/oaijs/oreo-router","last_synced_at":"2026-04-09T08:08:16.365Z","repository":{"id":94589997,"uuid":"114261378","full_name":"oaijs/oreo-router","owner":"oaijs","description":"Koa Router, Decorator Style.","archived":false,"fork":false,"pushed_at":"2017-12-20T12:26:18.000Z","size":362,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-15T06:50:59.254Z","etag":null,"topics":["decorator","decorators","koa","nodejs","openapi","oreo-router","router","swagger"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/oaijs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2017-12-14T14:40:24.000Z","updated_at":"2020-08-02T12:44:32.000Z","dependencies_parsed_at":"2023-03-02T22:15:47.931Z","dependency_job_id":null,"html_url":"https://github.com/oaijs/oreo-router","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/oaijs%2Foreo-router","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oaijs%2Foreo-router/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oaijs%2Foreo-router/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oaijs%2Foreo-router/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/oaijs","download_url":"https://codeload.github.com/oaijs/oreo-router/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241921824,"owners_count":20042763,"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":["decorator","decorators","koa","nodejs","openapi","oreo-router","router","swagger"],"created_at":"2024-11-15T01:20:50.877Z","updated_at":"2026-04-09T08:08:16.326Z","avatar_url":"https://github.com/oaijs.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[koa]: https://github.com/koajs/koa\n[koa-router]: https://github.com/alexmingoia/koa-router\n[proposal-decorators]: https://github.com/tc39/proposal-decorators\n[oai2.0]: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md\n[swagger-ui]: https://github.com/swagger-api/swagger-ui\n[babel-transform-decorators]: http://babeljs.io/docs/plugins/transform-decorators\n\n\u003c!-- @import \"[TOC]\" {cmd=\"toc\" depthFrom=1 depthTo=6 orderedList=false} --\u003e\n\u003c!-- code_chunk_output --\u003e\n\n* [Oreo-Router](#oreo-router)\n* [Warning](#warning)\n* [Features](#features)\n* [Installation](#installation)\n\t* [Requirement](#requirement)\n* [Getting Started](#getting-started)\n\t* [Creating koa app and router](#creating-koa-app-and-router)\n\t* [Creating controller](#creating-controller)\n\t* [Enjoying api-explorer](#enjoying-api-explorer)\n* [Documentation](#documentation)\n\n\u003c!-- /code_chunk_output --\u003e\n\n# Oreo-Router\n像奥利奥夹心饼干一样。通过装饰器的方式，轻松愉快的将服务的业务逻辑包装成接口，自动打包成一组API服务。当然还可以根据你的口味加一些你爱的调料！\n\n# Warning\n```sh\nPre-alpha版本，不建议在生产环境中使用。\n```\n\n# Features\n* [装饰器][proposal-decorators] 风格\n* 内置大量常用装饰器，并支持配置个性化处理中间件\n* 内置[Swagger-ui][swagger-ui]，可视化管理接口\n* 支持[OpenAPI 2.0][oai2.0]协议\n* 支持自定义装饰器\n* 自动识别并加载接口类，并根据装饰参数挂载成员方法路由\n* 继承自[Koa-Router][koa-router]，保持原功能、特性，性能。\n\n# Installation\n```sh\n# npm\nnpm install oreo-router --save\n\n# yarn\nyarn install oreo-router --save\n```\n\n## Requirement\n* [Koa2][koa]\n* [Babel decorators transform][babel-transform-decorators]\n\n# Getting Started\n\n## Creating koa app and router\n```js\n// index.js\n\nimport Koa from 'koa';\nimport { OreoRouter } from 'oreo-router';\n\nconst app = new Koa();\n\nconst router = new OreoRouter({\n  // 显示api-explorer(又叫swagger-ui)\n  apiExplorerEnable: true,\n  // 业务类的目录\n  middleware: {\n    dir: './controllers',\n  },\n});\n\n// 挂载所有从选项middleware中识别出来的路由\napp.use(router.routes());\n\napp.listen(3000, () =\u003e {\n  console.log(`\nListening Port : 3000\nApi-Explorer   : http://127.0.0.1:3000/api-explorer\n  `);\n});\n```\n\n## Creating controller\n```js\n// controllers/hello.js\n\nimport {\n  Middleware,   // Mean this is a api class.\n  Get,          // A definition of a GET operation on this path.\n  Summary,      // A short summary of what the operation does.\n  Description,  // A verbose explanation of the operation behavior.\n  Tags,         // A list of tags for API documentation control. Tags can be used for logical\n  Query,        // Parameters that are appended to the URL. For example, in /items?id=###, the query parameter is id.\n  Responses,    // The list of possible responses as they are returned from executing this operation.\n} from 'oreo-router';\n\n@Middleware('/hello')\nexport default class ExampleController {\n  @Get('/')\n  @Summary('hello')\n  @Description('oreo-router is awesome!')\n  @Tags(['example'])\n  @Query({\n    name: {\n      type: 'string',\n      required: true,\n    },\n  })\n  @Responses({\n    200: {\n      description: 'Request success.',\n    },\n  })\n  hello(ctx, next) {\n    ctx.response.body = `hello world! ${ctx.request.query.name}`;\n  }\n}\n```\n现在，我们已经完成了hello world接口的开发。让我们来简单了解一下上面例子中使用的各个装饰的作用吧。\n* **Get**装饰器说明该接口是一个HTTP GET方法，并且子路径是/。\n* **Summary**装饰器对该接口进行简单的描述。\n* **Description**装饰器对该接口进行一个详细的描述。\n* **Tags**装饰器可以对接口进行分组，相同tag的接口会展示在同一个组中。\n* **Query**装饰器对接口的query入参进行描述。\n* **Response**装饰器对接口的响应结果进行描述。\n* **hello**成员方法是我们的业务逻辑实现，是一个Koa中间件。\n\n通过这些装饰器，我们可以方便快捷的完成接口开发，当然我们还顺便完成了接口文档的编写哦：）。\n当然啦，功能远远不止于此。我们还可以为每个内置装饰器配置处理器中间件，以便做一些个性化的业务。比如我们可以为**Query**装饰器配置处理器中间件，来实现query表单的校验哦。更多玩法等你来挖掘！\n\n## Enjoying api-explorer\n使用浏览器打开api-explorer：http://127.0.0.1:3000/api-explorer，在这里你可以方便的查看服务提供的所有接口，以及每个接口的基本信息，入参格式、类型，返回结果的状态码、格式等等，甚至你还可以这里直接的调用它。\n![hello-world](/docs/hello-world.png)\n\n# Documentation\n* [Usage Guides](./docs/usage-guides.md)\n* [References](./docs/references.md)\n* [Examples](https://github.com/BiteBit/oreo-router-examples)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foaijs%2Foreo-router","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foaijs%2Foreo-router","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foaijs%2Foreo-router/lists"}