AspNetCore.RapiDoc
1.0.0
| 財産 | 説明 | デフォルト |
|---|---|---|
| RoutePrefix | Rapidocにアクセスするためのルートプレフィックス | 「Rapidoc」 |
| specurl | 表示するOpenapi仕様のURL | String.Empty |
| HeadingText | 左上コーナーの見出しテキスト | 「Rapidoc」 |
| ソートタグ | 許可： true |間違い タグをアルファベット順にリストするには、それ以外の場合は、仕様のタグセクションで指定されている方法に基づいてタグが注文されます。 | 間違い |
| sortendpointsby | 許可：パス|方法|まとめ 各タグ内のエンドポイントをパス、方法、または要約でソートします|例 | パス |
| Gotopath | スペックがロードされた後に行きたい場所（メソッドとパスで識別される）の初期位置。 たとえば、Scrollto get/user/loginをスクロールする場合は new PathInfo(SubmitMethod.Get,"/user/login")として場所を提供する必要があります。 | ヌル |
| fillrequestfieldswithexample | 許可： true |間違い リクエストフィールドには、例の例が記載されています（仕様で提供される場合） | 真実 |
| 財産 | 説明 | デフォルト |
|---|---|---|
| テーマ | さまざまなUIコンポーネントの色の計算に使用されるベーステーマです。 「テーマ」、「BG-Color」、「Text-Color」は、カスタムテーマを生成するための基本属性です | 暗い |
| bgcolor | 主な背景の色 | 暗いテーマ＃333 軽いテーマ#FFF |
| TextColor | テキストの色 | 暗いテーマ#BBB 軽いテーマ＃444 |
| HeaderColor | ヘッダーの背景の色 | ＃444444 |
| プライマリカラー | ボタン、タブなどのさまざまなコントロールの色 | ＃FF791A |
| loadfonts | Rapidocは、これが意図されていない場合は、CDNからフォントをロードしようとします。これをfalseに設定します。 | 真実 |
| レギュラーフォント | 通常のテキストに使用されるフォント名 | 「Open Sans」、Avenir、「Segoe Ui」、Arial、Sans-Serif |
| Monofont | モノ間隔のテキストに使用されるフォント名 | モナコ、 'andale mono'、 'roboto mono'、 'consolas' monospace |
| fontsize | ドキュメント全体に相対フォントサイズを設定します | デフォルト |
| 財産 | 説明 | デフォルト |
|---|---|---|
| usepathinnavbar | 要約/説明の代わりに、ナビゲーションバーにAPIパスを表示するように忠実に設定|例 | 間違い |
| navbgcolor | ナビゲーションバーの背景色の例 | |
| navbgimage | ナビゲーションバーの背景例のURL | String.Empty |
| navbgimagesize | ナビゲーションバーの背景画像サイズ（CSSバックグラウンドサイズプロパティと同じ） | 自動 |
| navbgimagerepeat | ナビゲーションバーの背景画像繰り返し（CSSバックグラウンドリピートプロパティと同じ） | norepeat |
| NavTextColor | ナビゲーションバーのテキスト色 | 色はありません |
| navhoverbgcolor | マウスオーバーのナビゲーションアイテムの背景色 | 色はありません |
| NavhoverTextColor | マウスオーバーのナビゲーションアイテムのテキスト色 | 色はありません |
| navaccentcolor | 現在の選択されたアイテムインジケーター | 色はありません |
| navitemspacing | ナビゲーションアイテム間隔の例を制御します | デフォルト |
| 財産 | 説明 | デフォルト |
|---|---|---|
| レイアウト | レイアウトは、リクエスト/応答セクションの配置に役立ちます。列のレイアウトでは、リクエストセクションと応答セクションが片方の下に配置され、行レイアウトでは並んで配置されます。この属性は、デバイスの幅が768pxを超え、レンダリングスタイルが「ビュー」である場合にのみ適用されます。 | 行 |
| レンダーシル | API-DOCの表示を決定します。現在、3つのモードがサポートされています 簡単に探索するためにフレンドリーを見る（興味のあるセクションを拡大/崩壊します） 読書に適した読み取り（連続Webページのように） 読み取りに似ていますが、一度に単一のエンドポイントに焦点を当てています（大きなスペックに適しています） もっと読むのに適しているビューを読むのに適していますよりフレンドリーな迅速な探索 | ビュー |
| onnavtagclick | 焦点を絞ったレンダリングスタイルにのみ適用されます。ナビゲーションバーのタグをクリックする動作を決定します。タグを展開するか、タグの説明ページに移動することができます。 | 拡張コルプス |
| スキーマスティル | 応答とリクエストボディにオブジェクトスキーマを表示する2つの異なる方法 | 木 |
| Schemaexpandlevel | スキーマはデフォルトで拡張されます。この属性を使用して、スキーマ内のレベルの数を制御する必要があります | 999 |
| schemadescriptionExpanded | 制約と説明スキーマ内のフィールドの情報は、最初の行のみを示すために崩壊します。あなたがそれらを完全に拡張したいなら、それを真に設定します | 間違い |
| Schemahidereadonly | リクエストスキーマに読み取り専用の提出は常に隠されていますが、それに応じて表示されます。 読み取り専用フィールドを非表示にしたり、アクションに基づいてそれらを非表示にしたくない場合は、この設定を「Never」または任意の投稿の組み合わせに設定できます。 put |どこに隠すかを示すパッチ 応答セクションのスキーマは、この設定の影響を受けません。 | いつも |
| Schemahidewriteonly | 制約と説明スキーマ内のフィールドの情報は、最初の行のみを示すために崩壊します。あなたがそれらを完全に拡張したいなら、それを真に設定します | いつも |
| defaultschematab | スキーマは、モデルと例の2つのタブに表示されます。このオプションを使用すると、アクティブにしたいデフォルトのタブを選択できます | モデル |
| Responseareaight | 400px、50％、60vhなどの有効なCSS高さ値 - この値を使用して、応答の高さを制御する | 「300px」 |
| 財産 | 説明 | デフォルト |
|---|---|---|
| showinfo | ドキュメント情報セクションを表示/非表示にします 情報セクションには、仕様のタイトルと説明、バージョン、サービスなどの仕様に関する情報が含まれています。特定の状況では、このセクションを表示する必要がない場合があります。たとえば、この要素を別のヘルプドキュメントに埋め込むことができます。おそらく、Docはすでにこの情報を持っているかもしれません。その場合、このセクションを隠すことができます。 | 真実 |
| infodescriptionheadingsinnavbar | 情報 - >説明セクションからナビゲーションバーへのヘッダーを含める（読み取りモードのみに適用） 情報 - 説明（H1およびH2）のマークダウンからヘッダーを左のメニュー（読み取りモード）に導き、リンクに導きます。このオプションにより、ユーザーはマークダウンを使用してナビゲーションバーアイテムを追加できます | 間違い |
| showcomponents | ドキュメントとメニューの両方でコンポーネントセクションを表示/非表示にします（フォーカスレンダリングスタイルでのみ使用できます） スキーマ、応答、例、リクエストボディ、ヘッダー、セキュリティシェーム、リンク、コールバックとともにコンポーネントセクションを表示します（左のメニューにも表示されます（読み取りモード） | 間違い |
| Showheader | ヘッダーを表示/非表示にします。 現在のAPI仕様以外のユーザーに他のAPI仕様を開いてもらいたくない場合は、この属性をFalseに設定してください | 真実 |
| 許容 | 認証機能により、ユーザーはスペックで利用可能な認証メカニズムのいずれかを選択できます。 HTTP-Basic、http-bearer、またはapi-keyにすることができます。ユーザーが認証プロセスを実行したくない場合は、代わりに事前に生成されたApi-Keyを使用してもらいたい場合は、この属性をfalseに設定して認証セクションを非表示にし、さまざまなApi-Keyを使用してApi-Keyの詳細を提供できます。属性 | 真実 |
| akspecurlload | 「false」に設定すると、ユーザーはUIから仕様URLをロードできません | 間違い |
| akspecfileload | 「false」に設定すると、ユーザーはローカルドライブから仕様ファイルをロードできません。この属性は、デバイスの幅が768pxを超えている場合にのみ適用されます。 | 間違い |
| aksearch | APIのクイックフィルタリングを提供します | 真実 |
| AlowAdvancedSearch | 高度な検索機能を提供し、APIパス、API説明、APIParameters、APi-Responsを検索します | 真実 |
| 許可します | 「Try」機能を使用すると、APIサーバーにREST呼び出しを行うことができます。この機能を無効にするには、falseに設定します。 | 真実 |
| aslowserverselection | 「false」に設定されている場合、ユーザーはAPIサーバーを表示または選択することができません（サーバーリストが非表示になりますが、ユーザーは「Try」ボタンの近くでサーバーURLを表示して、トライがリクエストを送信する場所を事前に知ることができます）。 SERVER-URL属性で指定されたURLは、設定されている場合、API仕様ファイルの最初のサーバーが使用されます。 | 真実 |
| akschemadescriptionexpandtoggle | スキーマ内のフィールドの説明を拡張/崩壊させる能力を許可または非表示にする | 真実 |
| 財産 | 説明 | デフォルト |
|---|---|---|
| serverurl | Openapi Specには、サーバーURLを提供するための規定があります。 UIは、仕様に提供されるすべてのサーバーURLをリストします。その後、ユーザーは、APIを試しているときにAPI呼び出しを送信するつもりである1つのURLを選択できます。ただし、仕様にリストされていない独自のAPIサーバーを提供する場合は、このプロパティを使用して提供できます。同じ仕様が複数の環境で共有され、DEVとテストとテストがあり、それぞれが独自のAPIサーバーを持っている場合に役立ちます。 | String.Empty |
| DefaultApiserver | スペックに複数のAPIサーバーがリストされている場合は、この属性を使用して、すべてのAPI呼び出しがGOTOが行われるデフォルトのAPIサーバーを選択します。これは、後でUIから変更できます | String.Empty |
| Apikeyname | APIを試している間に送信されるAPIキーの名前 | String.Empty |
| アピキロケーション | Api-Keyの送信方法を決定します | 設定されていません |
| apikeyvalue | APIを試している間に送信されるAPIキーの値。これは、UIから提供/上書きすることもできます | String.Empty |
| FetchCreDentials | ブラウザによって送信されるCORSリクエストで、フェッチ標準で定義されているクロスドメインコールで資格情報/Cookieを渡すことができます | 設定されていません |
| 財産 | 説明 | デフォルト |
|---|---|---|
| ロゴ | ヘッダーのデフォルトロゴを指定したURLに置き換えます | String.Empty |
| logowidth | カスタムロゴのロゴ幅を指定し、デフォルトのロゴには適用されません | 36 |
| ロゴハイト | カスタムロゴのロゴの高さを指定し、デフォルトのロゴには適用されません | 36 |
| logopadding | カスタムロゴのロゴパディングを指定し、デフォルトのロゴには適用されません | 0 |
| Navlogo | URLが提供されたサイドナビゲーションバーの上にナビゲーションロゴを追加しますが、読み取りモードでのみ利用可能です | String.Empty |
| Navlogowidth | カスタムロゴのナビゲーションロゴ幅を指定しますが、読み取りモードでのみ使用できます | 36 |
| Navlogoheight | カスタムロゴのナビゲーションロゴの高さを指定しますが、読み取りモードでのみ使用できます | 36 |
| Navlogopadding | カスタムロゴのナビゲーションロゴパディングを指定しますが、読み取りモードでのみ使用できます | 0 |
