# README

This is API v3 documentation.
The main change of this version is that it is easy to check the code and easier to test the API.

In API v3, we don't separate the API into different files like functions and apis. Instead, we put all the API in one file if they are related to each other. It will be decorated by the `@api` decorator.

## Rules

### 1. The API should be decorated by `@api` decorator.

```js
/**
 * @api {get} /api/v3/health Check the health of the API
 */
function health() {
  return 'OK';
}

export {
  health,
}
```