ITエンジニア/デザイナ向けにオープンソースを毎日紹介

開発者向けドキュメントの基本と言えるのがAPIドキュメントです。ライブラリだけでなく、最近ではWeb API向けのドキュメントも増えてきました。そのデファクトフォーマットになろうとしているのがSwagger/Open API Specification(OAS)です。

今回紹介するReDocはそんなSwagger/OASをベースにAPIドキュメントを生成するソフトウェアです。

ReDocの使い方

デモです。3カラム構成になっています。一番右側にJSON構造が書かれています。

スキーマが見やすくなっており、折りたたむこともできます。

右側のレスポンスについても折りたためますので見たいところだけをチェックできます。

SwaggerにはSwagger UIというビューワーがありますが、ReDocも負けず劣らず見やすいドキュメントではないでしょうか。公開されているJSONで自由に試せますので(CORS設定が必要ですが)手持ちのSwagger.jsonで試してみると良いでしょう。

ReDocはnode/JavaScript製のオープンソース・ソフトウェア(MIT License)です。

ReDoc

Rebilly/ReDoc: OpenAPI/Swagger-generated API Reference Documentation

 

MOONGIFTの関連記事

コメント

  • DevRel
  • Com2