AspNetCore.RapiDoc
1.0.0
| Eigentum | Beschreibung | Standard |
|---|---|---|
| Routeprefix | Routen Sie das Präfix für den Zugriff auf den Rapidoc | "Rapidoc" |
| Specurl | URL der OpenAPI -Spezifikation zur Anzeige | String.Empty |
| Überschrift | Übergangstext an der oberen linken Ecke | "Rapidoc" |
| Sorttags | Erlaubt: true | FALSCH Um Tags in alphabetischer Reihenfolge aufzulisten, werden die Tags ansonsten basierend darauf bestellt, wie es im Abschnitt Tags in der Spezifikation angegeben ist. | FALSCH |
| Sortendpointsby | Erlaubt: Pfad | Methode | Zusammenfassung Sortieren Sie Endpunkte in jedem Tag nach Pfad, Methode oder Zusammenfassung | Beispiel | Weg |
| Gotopath | Der erste Ort im Dokument (nach Methode und Pfad identifiziert), an dem Sie nach dem Laden der Spezifikation gehen möchten. Wenn Sie beispielsweise scrollto get/user/Login Scrollto -Get/Login möchten, sollten Sie den Standort als new PathInfo(SubmitMethod.Get,"/user/login") | NULL |
| FILLREQUESTFIELDSWITHMEMABLE | Erlaubt: true | FALSCH Die Anforderungsfelder werden mit einem Beispielwert gefüllt (falls in Spec angegeben) | WAHR |
| Eigentum | Beschreibung | Standard |
|---|---|---|
| Thema | Ist das Basisthema, das zur Berechnung von Farben für verschiedene UI -Komponenten verwendet wird. "Thema", "BG-Color" und "Textfarbe" sind die Grundattribute für die Generierung eines benutzerdefinierten Themas | Dunkel |
| BGColor | Farbe für Haupthintergrund | Dunkeles Thema #333 Leichtes Thema #fff |
| TextColor | Farbe für Text | Dunkeles Thema #BBB Leichtes Thema #444 |
| Headercolor | Farbe für den Hintergrund des Headers | #444444 |
| Primärkolor | Farbe an verschiedenen Steuerelementen wie Schaltflächen, Registerkarten | #Ff791a |
| Loadfonts | Rapidoc wird versuchen, Schriftarten von CDN zu laden, wenn dies nicht beabsichtigt ist, dann auf false festlegen. | WAHR |
| Regulär | Schriftartenname (n), die für den regulären Text verwendet werden sollen | "Open Sans", Avenir, "Segoe Ui", Arial, Sans-Serif |
| Monofont | Schriftart Name (n) für einen mono-sexuellen Text verwendet werden | Monaco, "Andale Mono", "Roboto Mono", "Consolas" Monospace |
| Schriftgröße | Legt die relativen Schriftgrößen für das gesamte Dokument fest | Standard |
| Eigentum | Beschreibung | Standard |
|---|---|---|
| UsePathinnavbar | Setzen Sie sich treu, um API -Pfade in der Navigationsleiste anstelle von Zusammenfassung/Beschreibung anzeigen | Beispiel | FALSCH |
| Navbgcolor | Beispiel für Navigationsleiste | |
| Navbgimage | URL des Hintergrundbeispiels der Navigationsleiste | String.Empty |
| Navbgimagesize | Hintergrundbildgröße der Navigationsleiste (wie CSS Hintergrundgröße Eigenschaft) | Auto |
| NavbgimageRepeat | Hintergrundbild der Navigationsleiste Wiederholung (wie CSS-Hintergrund-Wiederholungseigenschaft) | Norepeat |
| NavtextColor | Textfarbe der Navigationsleiste | Keine Farbe |
| NavhoverbgColor | Hintergrundfarbe des Navigationselements auf Maus-Over | Keine Farbe |
| NavhovertextColor | Textfarbe des Navigationselements auf Maus-Over | Keine Farbe |
| Marinecolor | Aktuelle ausgewählte Elementanzeige | Keine Farbe |
| Navitemspacing | Steuerelemente Navigation Element Abstandsbeispiel | Standard |
| Eigentum | Beschreibung | Standard |
|---|---|---|
| Layout | Layout hilft bei der Platzierung von Anforderungs-/Antwortabschnitten. In Spaltenlayout werden Anforderungs- und Antwortabschnitte untereinander platziert. In Zeilenlayout werden sie nebeneinander platziert. Dieses Attribut gilt nur, wenn die Gerätebreite mehr als 768px beträgt und der Render-Stil "Ansicht" ist. | Reihe |
| Rendersyle | Bestimmt die Anzeige von API-Docs. Derzeit werden drei Modi unterstützt Sehen Sie sich freundlich für eine schnelle Erkundung an (erweitern/kollabieren Sie den Abschnitt Ihres Interesses) Lesen Sie geeignet zum Lesen (wie eine kontinuierliche Webseite) Konzentriert sich ähnlich wie Lesen, konzentriert sich aber auf einen einzelnen Endpunkt (gut für große Spezifikationen) Lesen Sie besser geeignet für das Lesen von Ansicht freundlicher für schnelle Erkundungen | Sicht |
| Onnavtagclick | Gilt nur für fokussierte Renderstyle. Es bestimmt das Verhalten des Klickens auf ein Tag in der Navigationsleiste. Es kann entweder das Tag erweitern oder zur Beschreibung des Tags führen. | Expandcollapse |
| Schemastyle | Zwei verschiedene Möglichkeiten, Objektschemas in den Antworten anzuzeigen und Körper anfordern | Baum |
| Schemaexpandlevel | Die Schemas werden standardmäßig erweitert. Verwenden Sie dieses Attribut, um zu steuern, wie viele Ebenen im Schema erweitert werden sollten | 999 |
| Schemadienschreibungsexpandierte | Einschränkungen und Beschreibungen Informationen von Feldern im Schema werden zusammengebrochen, um nur die erste Zeile anzuzeigen. Stellen Sie es auf wahr ein, wenn Sie möchten, dass sie vollständig erweitert werden | FALSCH |
| Schemahidereadonly | Schreibgeschützte Einstellungen in Anforderungsschemata sind immer verborgen, werden jedoch als Antwort angezeigt. Wenn Sie keine schreibgeschützten Felder ausblenden oder basierend auf der Aktion ausblenden möchten, können Sie diese Einstellung in "Nie" oder eine Kombination aus Post | konfigurieren Put | Patch, um anzuzeigen, wo man sich verbergen soll Schemas als Reaktionsabschnitt sind von dieser Einstellung nicht beeinflusst. | Stets |
| Schemahidewriteonly | Einschränkungen und Beschreibungen Informationen von Feldern im Schema werden zusammengebrochen, um nur die erste Zeile anzuzeigen. Stellen Sie es auf wahr ein, wenn Sie möchten, dass sie vollständig erweitert werden | Stets |
| Standardschematab | Die Schemata werden in zwei Registerkarten angezeigt - Modell und Beispiel. Mit dieser Option können Sie die Registerkarte Standard auswählen, die Sie aktiv sein möchten | Modell |
| Responsearaheight | Gültiger CSS -Höhenwert wie 400px, 50%, 60 VH usw. - Verwenden Sie diesen Wert, um die Höhe des Antworttextbereichs zu steuern | "300px" |
| Eigentum | Beschreibung | Standard |
|---|---|---|
| ShowInfo | Zeigen/ausblenden Sie den Abschnitt "Dokumente im Info" Der Abschnitt "Info" enthält Informationen zur Spezifikation, wie z. B. den Titel und die Beschreibung der Spezifikation, die Version, die Bedingungen der Dienste usw. In einer bestimmten Situation müssen Sie diesen Abschnitt möglicherweise nicht anzeigen. Für die Instanz einbetten Sie dieses Element in ein anderes Hilfsdokument ein. Die Chancen stehen gut, dass die Hilfedokument möglicherweise bereits über diese Informationen verfügt, in diesem Fall möchten Sie diesen Abschnitt möglicherweise verbergen. | WAHR |
| Infodescriptionheadingsinnavbar | Fügen Sie Header von Info -> Beschreibung in die Navigationsleiste hinzu (gilt nur für den Lesemodus). Bringt die Header aus dem Markdown in Info - Beschreibung (H1 und H2) in das Menü links (im Lesemodus) zusammen mit Links zu ihnen. Mit dieser Option können Benutzer mit Markdown Navigationsleistenelemente hinzufügen | FALSCH |
| Showcomponenten | Zeigen/Ausblenden Sie den Abschnitt Komponenten sowohl im Dokument als auch im Menü (nur im fokussierten Render-Stil verfügbar) Zeigt den Abschnitt Komponenten zusammen mit Schemata, Antworten, Beispielen, RequestBodies, Header, SecuritySchemes, Links und Rückrufen auch im Menü links angezeigt (im Lesemodus). | FALSCH |
| ShowHeader | Zeigen/verstecken Sie den Kopf. Wenn Sie nicht möchten, dass Ihr Benutzer eine andere API -Spezifikation als die aktuelle öffnet, setzen Sie dieses Attribut auf false | WAHR |
| Zulassung | Mit der Authentifizierungsfunktion kann der Benutzer einen der Authentifizierungsmechanismus aus auswählen, die in der Spezifikation verfügbar sind. Es kann http-basic, http-Träger oder Api-Key sein. Wenn Sie nicht möchten, dass Ihre Benutzer den Authentifizierungsprozess durchlaufen und stattdessen einen vorgenerierten Api-Key verwenden, können Sie den Authentifizierungsabschnitt ausblenden, indem Sie dieses Attribut auf False einstellen und die Api-Key-Details mit verschiedenen Api-Kee angeben-???? Attribute | WAHR |
| Erlaubt pecurllload | Wenn der Benutzer auf "False" gesetzt ist, kann der Benutzer keine Spezifikations -URL aus der Benutzeroberfläche laden | FALSCH |
| Ermöglicht PecFileleleload | Wenn der Benutzer auf "False" gesetzt ist, kann der Benutzer keine Spezifikationsdatei aus dem lokalen Laufwerk laden. Dieses Attribut ist nur dann anwendbar, wenn die Gerätebreite mehr als 768px beträgt. Andernfalls ist diese Funktion nicht verfügbar | FALSCH |
| Ermöglicht die Suche | Bietet eine schnelle Filterung der API | WAHR |
| DademvancedSearch | Bietet fortgeschrittene Suchfunktionen, um API-Pfaden, API-Deschriften, API-Parameter und API-Responsen zu suchen | WAHR |
| Erlauben | Mit der Funktion "Try" können Sie REST -Anrufe zum API -Server tätigen. Um diese Funktion zu deaktivieren, setzen Sie es auf false. | WAHR |
| Ermöglicht die Auswahl | Wenn der Benutzer auf "False" festgelegt ist, kann der Benutzer API -Server nicht angezeigt oder auswählen (Serverliste wird versteckt. Benutzer können jedoch die Server -URL in der Nähe der Schaltfläche "Try" sehen, um im Voraus zu wissen, wo der Versuch die Anfrage sendet). Die im Server-URL-Attribut angegebene URL wird verwendet, wenn festgelegt wird. Andernfalls wird der erste Server in der API-Spezifikationsdatei verwendet. | WAHR |
| Ermöglicht ChemadetriptionExpandtoggle | Ermöglichen oder verbergen die Fähigkeit, Feldbeschreibungen im Schema zu erweitern/zu kollabieren | WAHR |
| Eigentum | Beschreibung | Standard |
|---|---|---|
| Serverurl | OpenAPI Spec hat eine Bestimmung für die Bereitstellung der Server -URL. In der Benutzeroberfläche werden alle in der Spezifikation bereitgestellten Server -URLs aufgeführt. Der Benutzer kann dann eine URL auswählen, an die er oder sie API -Anrufe senden möchte, während er die APIs ausprobiert. Wenn Sie jedoch einen eigenen API -Server bereitstellen möchten, der in der Spezifikation nicht aufgeführt ist, können Sie diese Eigenschaft verwenden, um eine bereitzustellen. Es ist hilfreich in den Fällen, in denen dieselbe Spezifikation zwischen mehreren Umgebungen mitspielsweise von Dev und Test geteilt wird und alle einen eigenen API -Server haben. | String.Empty |
| Defaultapiserver | Wenn Sie über mehrere API-Server in der Spezifikation aufgeführt sind, wählen Sie dieses Attribut, um den Standard-API-Server auszuwählen, auf dem alle API-Aufrufe ausgehen. Dies kann später aus der Benutzeroberfläche geändert werden | String.Empty |
| Apikeyname | Name der API -Taste, die beim Ausprobieren der APIs gesendet wird | String.Empty |
| Apikeylokation | Bestimmt, wie Sie den API-Schlüssel senden möchten | nicht gesetzt |
| ApikeyValue | Wert des API -Schlüssels, der beim Ausprobieren der APIs gesendet wird. Dies kann auch von der Benutzeroberfläche bereitgestellt/überschrieben werden | String.Empty |
| Fetchcredentials | Ermöglicht das Übergeben von Anmeldeinformationen/Cookies in Cross -Domänenanrufen, wie im Fetch -Standard definiert, in CORS | nicht gesetzt |
| Eigentum | Beschreibung | Standard |
|---|---|---|
| Logo | Ersetzt das Standardlogo des Headers durch die angegebene URL | String.Empty |
| Logowidth | Gibt die Logobreite des benutzerdefinierten Logos an und gilt nicht für das Standard -Logo | 36 |
| Logoheight | Gibt die Logohöhe des benutzerdefinierten Logos an und gilt nicht für das Standard -Logo | 36 |
| Logopadding | Gibt die Logo -Polsterung des benutzerdefinierten Logos an und gilt nicht für das Standard -Logo | 0 |
| Navlogo | Fügt ein Navigationslogo über der Seitennavigationsleiste mit der bereitgestellten URL hinzu, die nur im Read-Modus erhältlich ist | String.Empty |
| Navlogowidth | Gibt die Navigationslogo-Breite des benutzerdefinierten Logos an, nur im Read-Modus erhältlich | 36 |
| NavlogoHeight | Gibt die Höhe des benutzerdefinierten Navigationslogos des benutzerdefinierten Logos an, nur im Read-Modus erhältlich | 36 |
| Navlogopadding | Gibt die Navigationslogo-Polsterung des benutzerdefinierten Logos an, nur im Read-Modus erhältlich | 0 |
