What is docfy-ui

nestjs-docfyのコンパニオンプロジェクトである、AIファーストのOpenAPIドキュメントUIです。すべてのエンドポイントにCopy for AIボタンを備えた、洗練されモダンなAPIリファレンスです。

docfy-ui endpoint detail: request/response, Copy for AI, Copy OpenAPI, and multi-language snippets

動機

ほとんどのOpenAPI UIはページをスキャンする人間向けに作られていますが、今日ドキュメントを読むもう一方のオーディエンス、つまりコンテキストとして貼り付けるLLMにとっては誤った形式です。エンドポイントの詳細をコピーするには、通常、生のJSON(冗長で$refやノイズだらけ)を取得するか、レンダリングされたHTMLをコピーする(構造が失われる)しかありません。

例: Copy for AI

同じエンドポイントで「Copy for AI」をワンクリック:

text
## Create a user
POST /users

### Request
{
  "name": "string",
  "email": "string"
}

### Responses
201 Created (UserEntity)
400 Bad Request

### Validation
- name: required, minLength 2
- email: required, format email

docfy-uiは、追加の注釈もバックエンドの変更も一切必要とせず、既存のSwagger UIがすでに提供しているのと同じOpenAPIドキュメントから、このテキストを決定的に描画します。

機能

  • Copy for AI: すべてのエンドポイントが、生のJSONの代わりに、ワンクリックでプレーンテキストのLLM向けサマリー(目的、リクエスト、レスポンス、バリデーションルール)を得られます。
  • Copy OpenAPI: 選択したエンドポイントだけの、参照解決済みで循環参照にも安全なJSONフラグメントをコピーします。
  • Two-column endpoint view: 左側にドキュメント(パラメータ、レスポンス、ナビゲート可能なスキーマツリー)、右側にコードスニペット(curl、JavaScript、Python、Go)です。
  • Real-time search: キー入力のたびにpath/summary/operationIdでサイドバーをフィルタリングします。デバウンスもEnterキーも不要です。
  • Dark/light theme: トークン駆動で、リロードなし、初回描画時のちらつきなしで即座に切り替わります。
  • Zero backend coupling: OpenAPI 3.0/3.1のJSONドキュメントをクライアント側で取得します。NestJSに限らず、それを公開するどんなサーバーでも動作します。
  • Mobile-responsive: lgブレークポイント未満ではオフキャンバスのドロワーになります。375/390/768pxで検証済みです。
  • Compare specs: 2つのスペックURLを貼り付けると、追加・削除・変更されたエンドポイントを、それぞれBreakingまたはInformationalとしてフラグ付けして表示します。
  • Multi-spec switcher: ホストが複数のスペックを設定している場合、1つのインスタンスから複数のサービスを閲覧できます。そうでない場合は完全に非表示です。
docfy-ui real-time endpoint search (⌘K)