Oktatóanyag: Környezetek és telepítések hozzáadása API-khoz

Ez az oktatóanyag bemutatja, hogyan bővítheti a leltárt az API-központban az API-környezetekkel és az üzembe helyezésekkel kapcsolatos információk hozzáadásával.

  • A környezet egy olyan helyet jelöl, ahol egy API-futtatókörnyezet üzembe helyezhető, például egy API felügyeleti platformot.
  • Az üzembe helyezés olyan hely vagy cím, ahol a felhasználók hozzáférhetnek egy API-hoz.

Az API-kkal, az üzembe helyezésekkel és az Azure API Centerben leltározható egyéb entitásokkal kapcsolatos további információkért tekintse meg a fő fogalmakat.

Ebben az oktatóanyagban megtudhatja, hogyan használhatja a portált a következőkre:

  • Api-környezetekkel kapcsolatos információk hozzáadása
  • Az API-telepítésekkel kapcsolatos információk hozzáadása

Előfeltételek

Környezet hozzáadása

Az API-központ segítségével nyomon követheti a valós API-környezeteket. Használhatja például az Azure API Managementet vagy egy másik megoldást egyes API-k terjesztésére, védelmére és figyelésére. Vagy közvetlenül kiszolgálhat néhány API-t számítási felhőszolgáltatással vagy egy Kubernetes-fürttel.

Itt egy fiktív Azure API Management-környezettel kapcsolatos információkat adhat hozzá az API-központhoz. Ha szeretné, adjon meg információkat az egyik meglévő környezetéről. Konfigurálja a beépített metaadatokat és az előző oktatóanyagban definiált egyéni metaadatokat is.

  1. Jelentkezzen be az Azure Portalra, majd lépjen az API-központba.

  2. Az oldalsáv menü Leltár területén válassza a Környezetek>+ Új környezet lehetőséget.

  3. Az Új környezet lapon adja hozzá a következő információkat. Ha korábban definiálta az egyéni üzletági metaadatokat vagy a környezetekhez rendelt egyéb metaadatokat, azokat a lap alján láthatja.

    Setting Érték Description
    Környezet címe Adja meg a saját tesztelést. A környezethez választott név
    Azonosítás Az előző cím megadása után az Azure API Center létrehozza ezt az azonosítót, amelyet felülbírálhat. Azure-erőforrás neve a környezethez
    Környezet típusa Válassza a Tesztelés lehetőséget a legördülő listában. Az API-k környezetének típusa
    Leírás Ha szeretné, adjon meg egy leírást. A környezet leírása
    Kiszolgáló
    Típus Ha szeretné, válassza az Azure API Managementet a legördülő listából. A használt API felügyeleti megoldás típusa
    Felügyeleti portál URL-címe Ha szeretné, adjon meg egy URL-címet egy felügyeleti felülethez, például https://admin.contoso.com A környezet felügyeleti felületének URL-címe
    Bevezetés
    Fejlesztői portál URL-címe Ha szeretné, adjon meg egy URL-címet egy fejlesztői portálhoz, például https://developer.contoso.com A fejlesztői előkészítési felület URL-címe a környezetben
    Utasítások Ha szeretné, válassza a Szerkesztés lehetőséget , és adja meg az előkészítési utasításokat a standard Markdownban. Utasítások az API-k környezettel történő beépítéséhez
    Üzletág Ha hozzáadta ezt az egyéni metaadatot, tetszés szerint válasszon a legördülő listából, például IT. A környezetet kezelő üzleti egységet azonosító egyéni metaadatok

    Képernyőkép egy API-környezet portálon való hozzáadásáról.

  4. Válassza a Create gombot. A környezet megjelenik a környezetek listájában.

Üzembe helyezés hozzáadása

Az API-központ abban is segítséget nyújt, hogy katalogizálja az API-telepítéseket, illetve a futtatókörnyezeteket, ahol a nyomon követett API-k üzembe vannak helyezve.

Itt egy üzembe helyezést adhat hozzá úgy, hogy társítja az egyik API-t az előző szakaszban létrehozott környezettel. A beépített metaadatokat és a definiált egyéni metaadatokat is konfigurálhatja.

  1. Az Azure Portalon nyissa meg az API-központot.

  2. Az oldalsáv menü Leltár területén válassza az Eszközök lehetőséget.

  3. Válasszon ki egy API-t, például a Konferencia API-t.

  4. A Konferencia API oldalán, az oldalsáv menüjében válassza a Deployments>+ Add deployment (Üzembe helyezés hozzáadása) lehetőséget.

  5. Az Üzembe helyezés hozzáadása lapon adja hozzá a következő információkat. Ha korábban definiálta az egyéni üzletági metaadatokat vagy a környezetekhez rendelt egyéb metaadatokat, azokat a lap alján láthatja.

    Setting Érték Description
    Title Adja meg az 1. verzió üzembe helyezését. Az üzembe helyezéshez választott név
    Azonosítás Az előző cím megadása után az Azure API Center létrehozza ezt az azonosítót, amelyet felülbírálhat. Azure-erőforrás neve az üzembe helyezéshez
    Leírás Ha szeretné, adjon meg egy leírást. Az üzembe helyezés leírása
    Környezet Válasszon a legördülő listából, például a Saját tesztelés lehetőségből, vagy válassza az Új létrehozása lehetőséget. Új vagy meglévő környezet, ahol az API-verzió telepítve van
    Definíció Válasszon vagy adjon hozzá egy definíciós fájlt a Conference API egy verziójához. API-definíciós fájl
    Futtatókörnyezet URL-címe Adjon meg például egy alap URL-címet https://api.contoso.com. Az API alap futtatókörnyezeti URL-címe a környezetben
    Üzletág Ha hozzáadta ezt az egyéni metaadatot, tetszés szerint válasszon a legördülő listából, például IT. Egyéni metaadatok, amelyek azonosítják a környezetben lévő API-kat kezelő üzleti egységet

    Képernyőkép egy API-telepítés portálon való hozzáadásáról.

  6. Válassza a Create gombot. Az telepítés megjelenik a telepítések listájában.

Ebben az oktatóanyagban megtanulta, hogyan használhatja a portált a következőkre:

  • Api-környezetekkel kapcsolatos információk hozzáadása
  • Az API-telepítésekkel kapcsolatos információk hozzáadása

Kapcsolódó tartalom

  • Last updated on