Verwenden Sie Beispielanforderungen, die an eine API-Ressource gestellt werden, um Anforderungsheader-Zuordnungen, Abfrageparameterzuordnungen und ein Anforderungsschema für diese Ressource zu generieren.
Vorbereitungen
Ein Instanzadministrator muss die Systemeigenschaft festlegen glide.rest.sampling.enabledAuf „wahr“. Um die Wahrscheinlichkeit von Leistungsproblemen zu beschränken, aktivieren Sie die automatische Generierung von API-Anforderungsdefinitionen nur in Instanzen außerhalb der Produktion.
Erforderliche Rolle: web_service_admin
Prozedur
-
Erstellen Sie eine geskriptete Konfiguration für REST-API-Anforderungs-Sampling auf eine der folgenden Arten.
| Option | Verfahren |
|---|
| Navigieren Sie durch einen geskripteten REST-API-Datensatz |
- Navigieren zu an.
- Wählen Sie einen geskripteten REST-API-Datensatz aus.
- In Ressourcen Zugehörige Liste, wählen Sie eine Ressource aus.
- In Konfiguration Für Probenahme Anfordern Registerkarte auswählen Neu .
|
| Navigieren Sie direkt zu einer neuen geskripteten Konfiguration für REST-API-Anforderungs-Stichproben |
- Navigieren zu an.
- Wählen Sie Neu.
- In Rest-Ressource Feld die geskriptete REST-Ressource auswählen oder eingeben, für die automatisch Anforderungsdefinitionen generiert werden sollen.
|
-
In Max. Beispiele Geben Sie die Anzahl der Beispielanforderungen ein, die für die automatische Definitionsgenerierung analysiert werden sollen.
Sie müssen eine Zahl von 1 bis 1000 eingeben.
-
Wählen Sie Absenden.
An die Ressource gestellte Anforderungen werden zur Analyse bis zu der Anzahl der in Schritt 5 festgelegten Beispiele als Stichproben erfasst. Nachdem die maximale Anzahl von Mustern erreicht wurde, wird der Konfigurationsstatus der Anforderungs-Stichprobe auf festgelegt Analysiert Und REST-Anforderungs-Bereitstellungsschemas können überprüft werden.
Sie können auswählen Schließen Sie Das Sampling Ab Aus dem Datensatz der Anforderungs-Stichprobenkonfiguration zum Beenden der Stichprobe, bevor die maximale Anzahl von Mustern erreicht wurde.
-
Kehren Sie nach dem Ende des Stichprobenvorgangs zur von Ihnen erstellten Anforderungs-Stichprobenkonfiguration zurück, indem Sie die Nummer aus auswählen Konfiguration Für Probenahme Anfordern Registerkarte der geskripteten REST-Ressource.
-
Wählen Sie einen Datensatz aus Bereitstellungsschemata für REST-Anforderung Liste zum Überprüfen und Bearbeiten der automatisch generierten Anforderungsdefinitionen in Header , Textkörper , Und Abfrageparameter Felder.
Textkörper Struktur wird nur für generiert PUTUnd POSTHTTP-Methoden.
-
Wählen Sie Aus Commit Zum Hinzufügen der Definitionen zur geskripteten REST-API-Ressource und dem zugehörigen geskripteten REST-API-Service.
Ergebnisse
- Das Commit-REST-Anforderungs-Bereitstellungsschema und die Beispielanforderungen werden gelöscht.
- Header Feldinhalt wird verwendet, um die Anforderungsheader-Zuordnungen der Ressource zu erstellen. Die zugehörigen Anforderungsheader werden den relevanten REST-Services hinzugefügt Anforderungsheader Registerkarte.
- Textkörper Feldinhalt wird verwendet, um das Anforderungsschema der Ressource zu erstellen. Das Anforderungsschema der Ressource wird den relevanten REST-Services hinzugefügt Schemas Registerkarte.
- Abfrageparameter Feldinhalt wird verwendet, um die Zuordnungen der Abfrageparameter der Ressource zu erstellen. Die zugehörigen Abfrageparameter werden den relevanten REST-Services hinzugefügt Abfrageparameter Registerkarte.
- Alle von Ihnen hinzugefügten Commit-Anforderungsdefinitionen sind in der exportfähigen OpenAPI-Spezifikation im REST API-Explorer enthalten. Weitere Informationen zum Exportieren von OpenAPI-Spezifikationen finden Sie unter In OpenAPI-Spezifikation exportieren.