ReDoc - Swagger/OASを使ったWeb APIドキュメントジェネレータ MOONGIFT
開発者向けドキュメントの基本と言えるのがAPIドキュメントです。ライブラリだけでなく、最近ではWeb API向けのドキュメントも増えてきました。そのデファクトフォーマットになろうとしているのがSwagger/Open API Specification(OAS)です。 今回紹介するReDocはそんなSwagger/OASをベースにAPIドキュメントを生成するソフトウェアです。 ReDocの使い方 デモです。3カラム構成になっています。一番右側にJSON構造が書かれています。 スキーマが見やすくなっており、折りたたむこともできます。 右側のレスポンスについても折りたためますので見たいところだけをチェックできます。 SwaggerにはSwagger UIというビューワーがありますが、ReDocも負けず劣らず見やすいドキュメントではないでしょうか。公開されているJSONで自由に試せますので（CO
Swagger Editor - Swaggerフォーマットの編集とコード生成
MOONGIFTはオープンソース・ソフトウェアを紹介するブログです。2021年07月16日で更新停止しました SwaggerはWeb APIの標準記述フォーマットとして知られつつあります。標準ができるということは、それを使っていれば同じデータを使って他のフォーマットやサービスで使うことができるようになります。 すでにコード生成ライブラリなどが作られていますが、今回はSwagger向けのドキュメントを作れるSwagger Editorを紹介します。 Swagger Editorの使い方 こちらがメイン画面です。左側がエディタ、右側にその結果が表示されます。 イチから記述する他、JSONを貼り付けて読み込ませることもできます。 設定が多数用意されています。 クライアントやサーバサイドのコード生成が行えます。その結果はZipファイルでダウンロードできます。 例えばRubyのコードはこのようになり
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
