insomnia documenter

Postman Documenter に似ていますが、Insomnia 向けです。このツールを使用すると、Insomnia エクスポート ファイルを使用して美しい API ドキュメント ページを生成できます。

デモ: https://insodoc.github.io/insomnia-documenter/
チュートリアルとデモビデオ: https://www.youtube.com/watch?v=pq2u3FqVVy8

目次

• 目次
• 要件
• はじめる
  • npxの使用
  • パッケージをグローバルにインストールすることで
  • オプション
  • GitHub リリースの使用
• APIの更新
• カスタムルートパス
• ページをローカルで実行する
• 不眠症プラグイン
• 変更履歴
• 貢献
• ライセンス
• 企業向け不眠症ドキュメンタ

要件

• Node.js (8.x 以降を推奨)
• エクスポートされた Insomnia ワークスペース JSON (v4)

はじめる

Insomnia Documenter は、ドキュメント ページのセットアップを非常に簡単にする CLI ツールを提供します。 2通りの使い方ができます。

npxの使用

npx insomnia-documenter --config /path/to/insomnia/config.json

パッケージをグローバルにインストールすることで

npm i -g insomnia-documenter
insomnia-documenter --config /path/to/insomnia/config.json

オプション

 Options:
  -c, --config <location>  Location of the exported Insomnia JSON config.
  -l, --logo <location>    Project logo location (48x48px PNG).
  -f, --favicon <location>    Project favicon location (ICO).
  -o, --output <location>  Where to save the file (defaults to current working directory).
  -h, --help               output usage information

GitHub リリースの使用

あるいは、GitHub からリリース アーカイブをダウンロードし、 insomnia.jsonエクスポート ファイルをサイトのルート ディレクトリに追加することで、Insomnia Documenter の使用を開始することもできます。

APIの更新

API の更新は非常に簡単です。 Insomnia Documenter はプラグアンドプレイ Web アプリであるため、 insomnia.json新しくエクスポートされた JSON ファイルに置き換えるだけです。それがinsomnia.jsonという名前であることを確認してください。

実際、同じことがロゴ ( logo.png ) とファビコン ( favicon.ico ) にも当てはまります。

カスタムルートパス

同じドメイン上の複数の API を文書化したい場合がありますか?おそらく、GitHub ページでドキュメント ページをホストしたいと考えていますか?この場合 (他の多くの場合)、ルート パスが何であるかを指定する必要があります。これを行うには、 index.htmlを開いて次の行を置き換える必要があります。

 < div id =" app " > </ div >

次のようなもので:

 < div id =" app " data-root =" /path/to/docs " > </ div >

この場合、アプリは/path/to/docsディレクトリからinsomnia.jsonファイルを取得します。これにより、ドキュメント ページの管理方法をより柔軟に設定できるようになります (たとえば、エクスポート ファイルを Web ページのルート ディレクトリ以外の場所に保存できます)。 data-rootプロパティの末尾にスラッシュを入れないでください。

この属性を設定しても、ページのファビコンとロゴには影響しないことに注意してください。これらは引き続き、 index.htmlと同じディレクトリからロードされます。

ページをローカルで実行する

99.9% の場合、 index.htmlファイルを開くと読み込みに失敗します。これは、それがフェッチの仕組みに過ぎないためです。ページをローカルでプレビューするには、zeit/serve などのツールを使用するとよいでしょう。

npx serve

このページは http://localhost:5000 で利用可能になります。

不眠症プラグイン

devhammed は、Insomnia のインターフェースから直接ドキュメント ページを生成できる素晴らしい Insomnia プラグインを作成しました。プラグインを入手する(npm - github)

変更履歴

変更履歴ドキュメントを参照してください。

貢献

CLI ツールはコマンダー アプレットですが、フロントエンド自体は Svelte アプリです。このプロジェクトはまだベータ版であるため、バグがあり、あちこちで改善される可能性があります。貢献は大歓迎です:)

リポジトリのクローンを作成します。

git clone [email protected]:jozsefsallai/insomnia-documenter.git
cd insomnia-documenter

依存関係をインストールします。

npm install

デモの Insomnia エクスポート ファイルをコピーします。

cp docs/insomnia.json public/insomnia.json

ホットリロードを使用して開発ビルドを実行します。

npm run dev

実稼働ビルドを作成します。

npm run build

リンティング:

npm run lint

テスト:

npm run test 

ライセンス

マサチューセッツ工科大学

注: このプロジェクトは Kong および/または Insomnia とは提携していません。

企業向け不眠症ドキュメンタ

Tidelift サブスクリプションの一部として利用可能

Insomnia Documenter および他の何千ものパッケージのメンテナーは、Tidelift と協力して、アプリケーションの構築に使用するオープンソースの依存関係に対する商用サポートとメンテナンスを提供しています。使用する正確な依存関係の保守者に料金を支払いながら、時間を節約し、リスクを軽減し、コードの健全性を向上させます。もっと詳しく知る。