Definizione di parametri per una API

I parametri possono specificare elementi variabili di un percorso URL, parametri di query, intestazioni o corpo della richiesta.

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 all'origine YAML OpenAPI sottostante facendo clic sull'icona Origine Icona origine OpenAPI. Per tornare al modulo di progettazione, fare clic su Modulo Icona modulo.

Procedura

  1. Apri l'API per la modifica, come descritto in Modifica di una definizione API OpenAPI 2.0.
  2. Se sono già presenti uno o più parametri definiti, espandere Definizioni parametri.
  3. È possibile creare un nuovo parametro o modificare qualsiasi parametro esistente.
    • Per creare un parametro, fare clic sull'icona Aggiungi Icona OpenAPI 2.0 API add accanto a Parametri, quindi fare riferimento a Creazione di un parametro.
    • Per modificare un parametro esistente, fare clic sul nome del parametro nel quadro di navigazione, quindi fare riferimento a Modifica di un parametro.