https://github.com/sal-openlab/koa-abstract-route

Route Definition for Koa
https://github.com/sal-openlab/koa-abstract-route

Last synced: 3 months ago
JSON representation

Route Definition for Koa

• Host: GitHub
• URL: https://github.com/sal-openlab/koa-abstract-route
• Owner: sal-openlab
• License: mit
• Created: 2020-08-06T02:57:52.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-07-27T04:34:40.000Z (6 months ago)
• Last Synced: 2024-10-12T09:32:08.238Z (3 months ago)
• Language: TypeScript
• Size: 938 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# [koa-abstract-route](https://www.npmjs.com/package/koa-abstract-route)

[![npm](https://img.shields.io/npm/v/koa-abstract-route?logo=npm&color=blue)](https://www.npmjs.com/package/koa-abstract-route)

[![license](https://img.shields.io/npm/l/koa-abstract-route?color=blue)](./LICENSE)

[![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)

[![codecov](https://codecov.io/gh/sal-openlab/koa-abstract-route/graph/badge.svg?token=QKSZ9GSOP6)](https://codecov.io/gh/sal-openlab/koa-abstract-route)

API Router for Koa@2 middleware

## Features

- Easy to define your custom API routes

- Handles higher level content types of request/response

- Stream friendly

## Setup

koa-abstract-route requires **Node.js v16** or higher for ES2015 and async function support.

1. Add `koa-abstract-route` dependency to your project

```sh

$ npm install --save koa-abstract-route

```

## Example

- MyAPI.ts

````ts

import { AbstractRoute, APIParam } from 'koa-abstract-route';

export default class MyAPI extends AbstractRoute {

  constructor() {

    super({ prefix: '/api/v1' });

    /*

     * API Parameter definitions.

     */

    const apiParams: APIParam[] = [

      {

        /* Gets current server time.

         * @example

         * ```sh

         * $ curl -i http://127.0.0.1/api/v1/time

         * ```

         */

        method: 'GET',

        interface: {

          name: 'time',

          options: [

            {

              key: 'format',

              type: 'string',

              required: false,

              default: 'epoch',

              validate: {

                match: /^(epoch|iso)$/

              }

            }

          ]

        },

        response: {

          contentType: 'application/json'

        },

        observer: ({ request, response }, format: string): object => {

          return {

            timeStamp:

              format === 'epoch' ? Date.now() : new Date().toISOString()

          };

        }

      }

    ];

    try {

      this.routeAdd(apiParams);

    } catch (err) {

      console.error(err);

    }

  }

}

````

- Server.ts

```ts

import Koa from 'koa';

import MyAPI from './MyAPI';

const app = new Koa();

const api = new MyAPI();

app.use(api.router.routes());

const server = app.listen(80, () => {

  api.router.stack.forEach((route) => {

    console.info(`Route ${route.methods.join(', ')} ${route.path}`);

  });

});

```

## Constructor Options

### `prefix`

- Type: `String`

- Default: `''`

Prefix of URL routes.

## Development

1. Clone this repository

2. Install dependencies using `yarn install` or `npm install`

3. Start development server using `npm run dev`

## License

[MIT License](./LICENSE)

Copyright (c) [SAL Ltd.](https://sal.co.jp)