情報は一覧で出した方がいいことも、ビジュアル的に出した方がいいこともあります。それによって複雑性や、全体像の把握のしやすさが異なるでしょう。閲覧側が自由に選択できると便利です。 今回紹介するOpenAPI MapはOpenAPI Specificationのファイルをビジュアル化してくれるソフトウェアです。

OpenAPI Mapの使い方

OpenAPI Specification 3.0の場合。

ドリルダウンして全体像を把握できます。

より深いところまで辿ったところです。

2.0にも対応しています。

OpenAPI Mapでは選択したノードによって、右側に説明が表示されます。プロパティによっては一覧になっていたり、文章で説明が出ます。OpenAPI Specificationをより深く理解したり、APIの仕様を把握するのに役立つでしょう。

OpenAPI MapはJavaScript製のオープンソース・ソフトウェア(Apache Licnese 2.0)です。

OpenAPI Map arno-di-loreto/openapi-map: The OpenAPI Map (fka. OpenAPI Specification Visual Document) aims to help you find your way in the OpenAPI Specification (fka. Swagger Specification) documentation.