Werken met meerdere versies

Met API Designer kunt u met verschillende versies van dezelfde API-definitie werken om u te helpen uw API-levenscyclus te beheren. U kunt:

Een bestaande API-versie in productie behouden terwijl u aanzienlijke of ingrijpende wijzigingen in een nieuwe versie introduceert.
Zichtbaarheid en controle krijgen over gepubliceerde versies.
Flexibiliteit krijgen bij het ontwerpen van wijzigingen in een API.

Wanneer u een nieuwe versie van een API maakt, wordt alle inhoud naar de nieuwe versie gekopieerd en kan elke versie vervolgens onafhankelijk worden gewijzigd zonder de andere te beïnvloeden.

De startpagina van API Designer toont alle API's waarvan u de eigenaar bent en alle API-versies die met u zijn gedeeld.

Een nieuwe API-versie maken

Maak een nieuwe versie van een bestaande API-definitie.

U bent een eigenaar van de API of een bewerker van ten minste één versie van de API.

Ga op de startpagina naar de API waarvoor u een nieuwe versie wilt maken.
U kunt de lijst indien nodig filteren op naam of eigenaar.
Klik op de knop naast de versie die u wilt kopiëren en klik op Een nieuwe versie maken van <version>.
Voer de nieuwe versie in.
Klik op Maken.

Er wordt een nieuwe versie van uw API gemaakt met dezelfde inhoud als de bronversie. De mock en documentatie zijn standaard uitgeschakeld.

Een API-versie verwijderen

U bent een eigenaar van de API.

Klik op de startpagina op de knop naast de versie die u wilt verwijderen en klik op Verwijderen.
Klik op Verwijderen om te bevestigen.

De geselecteerde versie wordt verwijderd. Als u een volledige API wilt verwijderen, moet u elke versie verwijderen.

Versie-inhoud importeren

Importeer inhoud van een bestaand contract in een API-versie, waarbij de huidige inhoud wordt vervangen of samengevoegd.

U bent een eigenaar van de API of een bewerker van de API-versie.

Gebruik deze functie om een versie bij te werken vanuit een extern contractbestand zonder een nieuwe versie te maken. De versie-identificatie blijft behouden tijdens het importeren.

Dit is anders dan het importeren van een definitie, wat een nieuwe API maakt in API Designer.

Open Versie-inhoud importeren voor de versie die u wilt bijwerken.
U hebt toegang tot deze actie vanaf de volgende locaties:
- Klik op de startpagina op de menuknop naast de versie en klik op Versie-inhoud importeren.
- Selecteer op de startpagina de versie om het detailvenster te openen en klik vervolgens op Versie-inhoud importeren.
- Klik in de versie-editor op Bewerken > Versie-inhoud importeren.
Selecteer een indeling en een bron voor het te importeren contract.
U kunt importeren vanuit een lokaal bestand, een URL of tekst die u rechtstreeks in het dialoogvenster plakt.
Selecteer onder Gedrag hoe u de geïmporteerde inhoud wilt toepassen.
- Vervangen: overschrijft alle huidige inhoud met het geïmporteerde contract. De API-naam, versie-identificatie en specificatieversie blijven behouden.
- Samenvoegen: combineert de geïmporteerde inhoud met de bestaande versie-inhoud. De API-naam en versie-identificatie blijven behouden. Als een geïmporteerd element dezelfde naam heeft als een bestaand element, wordt het geïmporteerde element hernoemd met een achtervoegsel _merge (bijvoorbeeld User_merge). Dubbele basis-URL's en mediatypen worden overgeslagen.
Klik op Importeren.

De versie-editor wordt geopend met de bijgewerkte inhoud toegepast.

Was deze pagina nuttig?

Als u problemen ervaart op deze pagina of de inhoud onjuist is – een tikfout, een ontbrekende stap of een technische fout – laat het ons weten!

Geef hier uw feedback