Lavorare con più versioni

API Designer consente di lavorare con diverse versioni della stessa definizione di API per aiutare a gestire il ciclo di vita dell'API. È possibile:

Mantenere una versione dell'API esistente in produzione introducendo al contempo modifiche significative o di rottura in una nuova versione.
Ottenere visibilità e controllo sulle versioni pubblicate.
Ottenere flessibilità durante la progettazione delle modifiche a un'API.

Quando si crea una nuova versione di un'API, tutto il contenuto viene copiato nella nuova versione e ogni versione può quindi essere modificata in modo indipendente senza influire sulle altre.

La homepage di API Designer visualizza tutte le API di cui si è proprietari e tutte le versioni di API condivise con l'utente.

Creazione di una nuova versione dell'API

Creare una nuova versione di una definizione di API esistente.

Si è proprietari dell'API o editor di almeno una versione dell'API.

Nella homepage, andare all'API per la quale si desidera creare una nuova versione.
Se necessario, è possibile filtrare l'elenco per nome o proprietario.
Fare clic sul pulsante accanto alla versione che si desidera copiare e fare clic su Crea una nuova versione da <version>.
Inserire la nuova versione.
Fare clic su Crea.

Viene creata una nuova versione dell'API con lo stesso contenuto della versione di origine. Il mock e la documentazione sono disabilitati per impostazione predefinita.

Eliminazione di una versione dell'API

Si è proprietari dell'API.

Nella homepage, fare clic sul pulsante accanto alla versione che si desidera eliminare e fare clic su Elimina.
Fare clic su Elimina per confermare.

La versione selezionata viene eliminata. Se si desidera eliminare un'intera API, è necessario eliminare ogni versione.

Importazione del contenuto della versione

Importare il contenuto da un contratto esistente in una versione dell'API, sostituendo o unendo il suo contenuto corrente.

Si è proprietari dell'API o editor della versione dell'API.

Utilizzare questa funzionalità per aggiornare una versione da un file di contratto esterno senza creare una nuova versione. L'identificatore della versione viene mantenuto durante l'importazione.

Questo è diverso dall'importazione di una definizione, che crea una nuova API in API Designer.

Aprire Importa contenuto versione per la versione che si desidera aggiornare.
È possibile accedere a questa azione dalle seguenti posizioni:
- Nella homepage, fare clic sul pulsante del menu accanto alla versione e fare clic su Importa contenuto versione.
- Nella homepage, selezionare la versione per aprire il riquadro dei dettagli, quindi fare clic su Importa contenuto versione.
- Nell'editor della versione, fare clic su Modifica > Importa contenuto versione.
Selezionare un formato e un'origine per il contratto da importare.
È possibile importare da un file locale, un URL o un testo incollato direttamente nella finestra di dialogo.
In Comportamento, selezionare come applicare il contenuto importato.
- Sostituisci: sovrascrive tutto il contenuto corrente con il contratto importato. Il nome dell'API, l'identificatore della versione e la versione della specifica vengono mantenuti.
- Unisci: combina il contenuto importato con il contenuto della versione esistente. Il nome dell'API e l'identificatore della versione vengono mantenuti. Se un elemento importato ha lo stesso nome di un elemento esistente, l'elemento importato viene rinominato con un suffisso _merge (ad esempio, User_merge). Gli URL di base e i tipi di media duplicati vengono ignorati.
Fare clic su Importa.

L'editor della versione si apre con il contenuto aggiornato applicato.

Hai trovato utile questa pagina?

Se riscontri problemi con questa pagina o con il suo contenuto – un errore di battitura, un passaggio mancante o un errore tecnico – ti pregiamo di farcelo sapere!

Lascia qui il tuo feedback