Convalida dell'origine YAML OpenAPI
Come convalidare l'origine YAML OpenAPI rispetto alle specifiche swagger quando stai modificando un'API.
Informazioni su questa attività
Quando configuri un'API nell'editor API, puoi convalidare l'origine YAML OpenAPI facendo clic su . Se vengono trovati degli errori di convalida del programma di analisi swagger, viene visualizzata un'icona di errore su cui è possibile fare clic per visualizzare i singoli errori e dove si verificano nello YAML. Puoi quindi correggere gli errori, salvare gli aggiornamenti e continuare a convalidare lo YAML OpenAPI durante il processo di configurazione dell'API.
Nota:
- La validazione di OpenAPI non mostra errori di gateway o di politica che impediscano alla tua API di essere preparata o pubblicata. Questo tipo di convalida si verifica solo quando tenti di preparare o pubblicare la tua API. Per ulteriori informazioni, vedi In fase di preparazione di un'API o Pubblicazione di un'API.
- Puoi anche convalidare il documento API utilizzando le serie di regole governance . Per ulteriori informazioni, vedi Convalida di un'API o di un documento del prodotto utilizzando il servizio di governance.
Puoi completare questa attività utilizzando l'applicazione IU API Designer o utilizzando l'IU API Manager basata sul browser.
Procedura
Per convalidare l'origine YAML OpenAPI , completa la seguente procedura.
- Aprire l'API richiesta per la modifica, come descritto in Modifica di una definizione API OpenAPI 2.0 o Modifica di una definizione API OpenAPI 3.0.
- Fare clic su dalla barra dei menu nell'intestazione.
- Se vengono rilevati degli errori di convalida del parser swagger, viene visualizzata un'icona di errore sulla barra dei menu dell'intestazione, con il numero di errori OpenAPI accanto all'icona. Ad esempio,
. - È quindi possibile fare clic sull'icona dell'errore per visualizzare un elenco dettagliato degli errori e la relativa posizione nello YAML. Se ti trovi nella vista Modulo
, puoi fare clic su un singolo errore per passare direttamente alla relativa sezione API nel modulo. - Dopo aver corretto l'errore, fare clic su Salva per salvare gli aggiornamenti, quindi fare nuovamente clic su Convalida .
- Quando tutti gli errori vengono corretti, la convalida restituisce un messaggio di esito positivo. Ad esempio,
.