https://github.com/koajs/api-boilerplate

API application boilerplate
https://github.com/koajs/api-boilerplate

Last synced: 2 months ago
JSON representation

API application boilerplate

• Host: GitHub
• URL: https://github.com/koajs/api-boilerplate
• Owner: koajs
• Archived: true
• Created: 2013-12-19T05:25:41.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2019-02-28T09:51:15.000Z (almost 6 years ago)
• Last Synced: 2024-04-14T13:08:39.056Z (8 months ago)
• Language: JavaScript
• Size: 21.5 KB
• Stars: 309
• Watchers: 10
• Forks: 35
• Open Issues: 8
• Metadata Files:
  • Readme: Readme.md

Awesome Lists containing this project

• awesome-koa - api-boilerplate - API application boilerplate (Middleware)

README

        

# Koa API Boilerplate

  Boilerplate API application structure - at least one flavour.

## Installation

  cloneeeee

## Usage

```

  Usage: api [options]

  Options:

    -h, --help            output usage information

    -H, --host      specify the host [0.0.0.0]

    -p, --port      specify the port [4000]

    -b, --backlog   specify the backlog size [511]

```

## Structure

  Resources and associated tests are defined in ./api

##  Tests

  Run `make test`

## API Versioning

  Use a proxy for `/v1`, `/v2` etc and launch new `api(1)` programs, don't version

  in the same application, it's brittle, bloaty and pointless.

# License

  MIT