{"id":15462825,"url":"https://github.com/sal-openlab/koa-abstract-route","last_synced_at":"2026-02-27T03:32:06.810Z","repository":{"id":60231848,"uuid":"285458413","full_name":"sal-openlab/koa-abstract-route","owner":"sal-openlab","description":"Route Definition for Koa","archived":false,"fork":false,"pushed_at":"2025-09-22T03:32:31.000Z","size":1055,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-24T19:55:45.474Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/sal-openlab.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2020-08-06T02:57:52.000Z","updated_at":"2025-09-22T03:32:34.000Z","dependencies_parsed_at":"2023-02-13T07:01:28.741Z","dependency_job_id":"4cf2ca84-4a8f-46a6-9394-67880360994a","html_url":"https://github.com/sal-openlab/koa-abstract-route","commit_stats":{"total_commits":24,"total_committers":1,"mean_commits":24.0,"dds":0.0,"last_synced_commit":"f55568b22b25bb8800bbb3060ab4458d786d7169"},"previous_names":["sal-openlab/koa-abstract-route"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/sal-openlab/koa-abstract-route","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sal-openlab%2Fkoa-abstract-route","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sal-openlab%2Fkoa-abstract-route/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sal-openlab%2Fkoa-abstract-route/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sal-openlab%2Fkoa-abstract-route/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sal-openlab","download_url":"https://codeload.github.com/sal-openlab/koa-abstract-route/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sal-openlab%2Fkoa-abstract-route/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29883715,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-26T23:51:21.483Z","status":"online","status_checked_at":"2026-02-27T02:00:06.759Z","response_time":57,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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-10-02T00:05:08.711Z","updated_at":"2026-02-27T03:32:06.796Z","avatar_url":"https://github.com/sal-openlab.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# [koa-abstract-route](https://www.npmjs.com/package/koa-abstract-route)\n\n[![npm](https://img.shields.io/npm/v/koa-abstract-route?logo=npm\u0026color=blue)](https://www.npmjs.com/package/koa-abstract-route)\n[![license](https://img.shields.io/npm/l/koa-abstract-route?color=blue)](./LICENSE)\n[![build](https://img.shields.io/github/actions/workflow/status/sal-openlab/koa-abstract-route/ci.yml?logo=github)](https://github.com/sal-openlab/koa-abstract-route/actions?query=workflow%3Aci)\n[![codecov](https://codecov.io/gh/sal-openlab/koa-abstract-route/graph/badge.svg?token=QKSZ9GSOP6)](https://codecov.io/gh/sal-openlab/koa-abstract-route)\n\nAPI Router for Koa@2 middleware\n\n## Features\n\n- Easy to define your custom API routes\n- Handles higher level content types of request/response\n- Stream friendly\n\n## Setup\n\nkoa-abstract-route requires **Node.js v16** or higher for ES2015 and async function support.\n\n1. Add `koa-abstract-route` dependency to your project\n\n```sh\n$ npm install --save koa-abstract-route\n```\n\n## Example\n\n- MyAPI.ts\n\n````ts\nimport { AbstractRoute, APIParam } from 'koa-abstract-route';\n\nexport default class MyAPI extends AbstractRoute {\n  constructor() {\n    super({ prefix: '/api/v1' });\n\n    /*\n     * API Parameter definitions.\n     */\n    const apiParams: APIParam[] = [\n      {\n        /* Gets current server time.\n         * @example\n         * ```sh\n         * $ curl -i http://127.0.0.1/api/v1/time\n         * ```\n         */\n        method: 'GET',\n        interface: {\n          name: 'time',\n          options: [\n            {\n              key: 'format',\n              type: 'string',\n              required: false,\n              default: 'epoch',\n              validate: {\n                match: /^(epoch|iso)$/\n              }\n            }\n          ]\n        },\n        response: {\n          contentType: 'application/json'\n        },\n        observer: ({ request, response }, format: string): object =\u003e {\n          return {\n            timeStamp:\n              format === 'epoch' ? Date.now() : new Date().toISOString()\n          };\n        }\n      }\n    ];\n\n    try {\n      this.routeAdd(apiParams);\n    } catch (err) {\n      console.error(err);\n    }\n  }\n}\n````\n\n- Server.ts\n\n```ts\nimport Koa from 'koa';\nimport MyAPI from './MyAPI';\n\nconst app = new Koa();\nconst api = new MyAPI();\napp.use(api.router.routes());\n\nconst server = app.listen(80, () =\u003e {\n  api.router.stack.forEach((route) =\u003e {\n    console.info(`Route ${route.methods.join(', ')} ${route.path}`);\n  });\n});\n```\n\n## Constructor Options\n\n### `prefix`\n\n- Type: `String`\n- Default: `''`\n\nPrefix of URL routes.\n\n## Development\n\n1. Clone this repository\n2. Install dependencies using `yarn install` or `npm install`\n3. Start development server using `npm run dev`\n\n## License\n\n[MIT License](./LICENSE)\n\nCopyright (c) [SAL Ltd.](https://sal.co.jp)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsal-openlab%2Fkoa-abstract-route","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsal-openlab%2Fkoa-abstract-route","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsal-openlab%2Fkoa-abstract-route/lists"}