express-openapi-sample

ExpressのOpen API(旧Swagger)フレームワークを使って、Todoアプリをつくる

使い方

Node.jsはとりあずv6.0以上

• node.js >= v6.0

Install

$ npm install

Build

$ npm run build

Test

$ npm run test

メモ

Open APIについて

RESTful APIのインターフェイスを記述するフォーマット。 express-oepnapiでは、paths部分を空にしてしまうので、オリジナルはapi_original.ymlを参照。

• OpenAPI Specification
• express-openapi

APIのパスについて

APIのベースパスは、api.yml#L2部分で定義する。 ここで指定したbasePathがhttp://example.com/{basePath}/のようになる。 apiだったり1.0のようなAPIバージョンを書くことが多い。

エンドポイントは、src/api以下でファイル名やディレクトリ名がそのままパスになる。

ディレクトリについて

.src
├── index.ts               // expressを起動させるためのコード
├── Server.ts              // コア部分
├── api.ts                 // レスポンス処理の共通処理
├── api                    // APIパス（この配下がエンドポイントになっていく）
│   ├── tasks              // basePath/tasks/...
│   │   └── {id}.ts        // basePath/tasks/{id}
│   └── tasks.ts           // basePath/tasks
├── models
│   ├── Task.ts            // Taskテーブルの定義
│   └── TaskController.ts  // Taskテーブルを操作する
└── store
    └── index.ts           // データベースの設定

バリデーションについて

src/apiで定義されているapiDocにより、pathやbodyパラメータのバリデーションが行われる。