Swagger3.0でexampleを利用したモックを最速で立てる方法


前書き

Swagger3.0に対応していてかつexampleを利用したレスポンスを返してくれるモックを求めていた。
Codegenなども調べたがスケルトンコードが出力されたのでほかの方法を模索

立て方

  1. 以下からOSに合わせたバイナリをダウンロード

  2. 解凍先でいずれかのコマンドを実行

apisprout 【対象ymlファイル】
apisprout 【対象ymlファイルのURL】

たったこれだけ、以上!!
デフォルトポートは8000

yaml記述の注意

componentsセクションのexampleとして記述すること。
オブジェクトやプロパティのexampleとしてでは記述時点では反応しない

paths:
  /:
    get:
      responses:
        '200':
          content:
            application/json:
              examples: #←ここ

参考先

感想

  • ファイルを指定するだけでモックが起動できる最高!!
  • ソースをあまり読めてないけれども、Golangの極めて短いコードで実現されていてすごい