README.md

node-oas3-mock-server

OAS3.0(OpenAPI Specification 3.0)で定義されているYAMLファイルをロードしてAPIのモックサーバーを立てる

機能

• OAS3.0で定義されているYAMLファイルを読み込みAPIモックサーバーを立てる
• GET, POST, PUT, DELETE メソッドに対応
• 定義参照対応 ($ref: path/to/)

補足

OAS3.0で記述されたYAMLファイルかつAPIにschemaまたはexampleの定義が記述されている必要があります。

使い方

package.jsonのAPIDOC_PATHをYAMLがあるディレクトリパスに変更

{
  "scripts": {
    "start": "cross-env APIDOC_PATH=\"./examples\" micro -l tcp://localhost:8080 src"
  }
}

サーバー立ち上げ

$ yarn install
$ yarn start

サンプル

$ curl -X GET http://localhost:8080/api/petstore/pets
[{"id":1,"name":"lovely","tag":"dog"},{"id":2,"name":"robert","tag":"dog"},{"id":3,"name":"orafu","tag":"dog"}]

$ curl -X GET http://localhost:8080/api/petstore/pets/1
{"id":1,"name":"lovely","tag":"dog"}