Morning Girl

Web API, Windows, C#, .NET, Dynamics 365/CRM etc..

JSON から OpenAPI(Swagger) Spec のモデルを生成するのに「Swagger toolbox」が便利

OpenAPI(Swagger)Spec を書いていて、真っ先に面倒かつ苦痛なのが Model 部分の定義だと思います。

予め OpenAPI Spec を生成するように Web API側を定義していたりすれば、話は別ですが API Design First で構成していく場合、大量の定義をYAMLで書いていかないといけません。 また、すでに存在しているWeb APIからOpen API Specを書き起こす、みたいなプロジェクトの場合も同様ですね。

そんな苦痛な Model 生成が「Swagger toolbox」というWebアプリで一層(半分くらい)できるのでオススメです。

swagger-toolbox.firebaseapp.com

f:id:sugimomoto:20200118192849p:plain

使い方は簡単です。左側に Model を生成したいJSONを貼り付けて「Convert」をクリックするだけ。

もし、Example を含めたい場合は「Include the example to the output」にチェックを入れればOK。

素晴らしい。