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"}