Definizione di parametri per un'operazione

Le risposte definiscono il codice di stato dell' HTTP e e i dati restituiti in un corpo di risposta e nelle intestazioni.

Informazioni su questa attività

Nota: questa attività fa riferimento alla configurazione di una definizione API OpenAPI 2.0 . Per i dettagli su come configurare una definizione API OpenAPI 3.0 , vedi Modifica di una definizione API OpenAPI 3.0.

Puoi completare questa attività utilizzando l'applicazione IU API Designer o utilizzando l'IU API Manager basata sul browser.

In qualsiasi momento puoi passare direttamente al codice sorgente YAML sottostante dell' OpenAPI, cliccando Icona origine OpenAPI sull'icona "Sorgente". Per tornare al modulo di progettazione, clicca sull'icona Icona moduloModulo.

Procedura

  1. Apri l'API per la modifica, come descritto in Modifica di una definizione API OpenAPI 2.0.
  2. espandere Percorsi, quindi espandere il percorso richiesto.
  3. Espandere Operazioni, quindi espandere l'operazione richiesta.
  4. È possibile creare un nuovo parametro di operazione o modificare qualsiasi parametro esistente.
    • Per creare un parametro di operazione, fare clic sull'icona di aggiunta Icona OpenAPI 2.0 API add accanto a "Parametri percorso ", quindi consultare la sezione "Creazione di un parametro".
    • Per modificare un parametro di operazione esistente, fare clic sul nome del parametro nel riquadro di navigazione, quindi consultare la sezione Modifica di un parametro.