Delen via

Zelfstudie: Omgevingen en implementaties voor API's toevoegen

  • Artikel

Vergroot de inventaris in uw API-centrum door informatie over API-omgevingen en implementaties toe te voegen.

  • Een omgeving vertegenwoordigt een locatie waar een API-runtime kan worden geïmplementeerd, bijvoorbeeld een API Management-platform.

  • Een implementatie is een locatie (een adres) waar gebruikers toegang hebben tot een API.

Zie Belangrijke concepten voor achtergrondinformatie over API's, implementaties en andere entiteiten die u in Azure API Center kunt inventariseren.

In deze zelfstudie leert u hoe u de portal gebruikt voor het volgende:

  • Informatie over API-omgevingen toevoegen
  • Informatie over API-implementaties toevoegen

Vereisten

Een omgeving toevoegen

Gebruik uw API-centrum om uw echte API-omgevingen bij te houden. U kunt bijvoorbeeld Azure API Management of een andere oplossing gebruiken om sommige API's te distribueren, beveiligen en bewaken. Of u kunt bepaalde API's rechtstreeks bedienen met behulp van een rekenservice of een Kubernetes-cluster.

Hier voegt u informatie over een fictieve Azure API Management-omgeving toe aan uw API-centrum. Voeg desgewenst informatie toe over een van uw bestaande omgevingen. U configureert zowel ingebouwde metagegevens als aangepaste metagegevens die u in een vorige zelfstudie hebt gedefinieerd.

  1. Navigeer in de portal naar uw API-centrum.

  2. Selecteer in het linkermenu onder Assets de optie Omgevingen>+ Nieuwe omgeving.

  3. Voeg op de pagina Nieuwe omgeving de volgende informatie toe. Als u eerder de aangepaste line-of-business-metagegevens of andere metagegevens hebt gedefinieerd die zijn toegewezen aan omgevingen, ziet u deze onder aan de pagina.

    Instelling Weergegeven als Beschrijving
    Omgevingstitel Voer mijn test in. De naam die u kiest voor de omgeving.
    Kenmerk Nadat u de voorgaande titel hebt ingevoerd, genereert Azure API Center deze id, die u kunt overschrijven. Azure-resourcenaam voor de omgeving.
    Omgevingstype Selecteer Testen in de vervolgkeuzelijst. Type omgeving voor API's.
    Beschrijving Voer desgewenst een beschrijving in. Beschrijving van de omgeving.
    Server
    Type Selecteer desgewenst Azure API Management in de vervolgkeuzelijst. Het type API Management-oplossing dat wordt gebruikt.
    URL van beheerportal Voer desgewenst een URL in voor een beheerinterface, zoals https://admin.contoso.com URL van beheerinterface voor omgeving.
    Onboarding
    URL van de ontwikkelingsportal Voer desgewenst een URL in voor een ontwikkelaarsportal, zoals https://developer.contoso.com URL van interface voor onboarding van ontwikkelaars in de omgeving.
    Instructies Selecteer desgewenst Bewerken en voer onboarding-instructies in standaard Markdown in. Instructies voor onboarding naar API's vanuit de omgeving.
    Line-of-Business Als u deze aangepaste metagegevens hebt toegevoegd, kunt u desgewenst een selectie maken in de vervolgkeuzelijst, zoals IT. Aangepaste metagegevens die de bedrijfseenheid identificeren die de omgeving beheert.

    Schermopname van het toevoegen van een API-omgeving in de portal.

  4. Selecteer Maken. De omgeving wordt weergegeven in de lijst met omgevingen.

Een implementatie toevoegen

API Center kan u ook helpen bij het catalogiseren van uw API-implementaties: de runtime-omgevingen waar de API's die u bijhoudt, worden geïmplementeerd.

Hier voegt u een implementatie toe door een van uw API's te koppelen aan de omgeving die u in de vorige sectie hebt gemaakt. U configureert zowel ingebouwde metagegevens als aangepaste metagegevens die u hebt gedefinieerd.

  1. Navigeer in de portal naar uw API-centrum.

  2. Selecteer API's in het linkermenu onder Assets.

  3. Selecteer een API, bijvoorbeeld de Conferentie-API.

  4. Selecteer op de pagina Conferentie-API onder Details de optie Implementaties>+ Implementatie toevoegen.

  5. Voeg op de pagina Implementatie toevoegen de volgende informatie toe. Als u eerder de aangepaste line-of-business-metagegevens of andere metagegevens hebt gedefinieerd die zijn toegewezen aan omgevingen, ziet u deze onder aan de pagina.

    Instelling Weergegeven als Beschrijving
    Titel Voer V1-implementatie in. De naam die u kiest voor de implementatie.
    Kenmerk Nadat u de voorgaande titel hebt ingevoerd, genereert Azure API Center deze id, die u kunt overschrijven. Azure-resourcenaam voor de implementatie.
    Beschrijving Voer desgewenst een beschrijving in. Beschrijving van de implementatie.
    Omgeving Maak een selectie in de vervolgkeuzelijst, zoals Mijn testen, of selecteer desgewenst Nieuwe maken. Nieuwe of bestaande omgeving waarin de API-versie wordt geïmplementeerd.
    Definitie Selecteer of voeg een definitiebestand toe voor een versie van de Conferentie-API. API-definitiebestand.
    Runtime-URL Voer bijvoorbeeld https://api.contoso.comeen basis-URL in. Basisruntime-URL voor de API in de omgeving.
    Line-of-Business Als u deze aangepaste metagegevens hebt toegevoegd, kunt u desgewenst een selectie maken in de vervolgkeuzelijst, zoals IT. Aangepaste metagegevens die de bedrijfseenheid identificeren die API's in de omgeving beheert.

    Schermopname van het toevoegen van een API-implementatie in de portal.

  6. Selecteer Maken. De implementatie wordt weergegeven in de lijst met implementaties.

In deze zelfstudie hebt u geleerd hoe u de portal gebruikt voor het volgende:

  • Informatie over API-omgevingen toevoegen
  • Informatie over API-implementaties toevoegen

Gerelateerde inhoud