Megosztás a következőn keresztül:

API manuális hozzáadása

Erre vonatkozik: Minden API-kezelési szint

Ez a cikk bemutatja, hogyan adhat hozzá manuálisan API-t az Azure API Managementhez. Ha szimulált válaszokat szeretne létrehozni az API-ból, létrehozhat egy üres API-t. A modell API-válaszok létrehozásával kapcsolatos információkért lásd a Mock API-válaszokat.

Ha meglévő API-t szeretne importálni, tekintse meg a cikk Kapcsolódó tartalom szakaszát.

Ebből a cikkből megtudhatja, hogyan hozhat létre üres API-t. A httpbin.org (nyilvános tesztelési szolgáltatás) háttér API-ként lesz megadva.

Előfeltételek

Nyissa meg az API Management-példányát

  1. Az Azure portálonkeresse meg és válassza ki a API Management szolgáltatásokat:

    képernyőkép, amely az API Management-szolgáltatásokat jeleníti meg a keresési eredmények között.

  2. Az API Management-szolgáltatások lapon válassza ki az API Management-példányt:

    Képernyőkép, amely egy API Management-példányt jelenít meg az API Management szolgáltatások lapján.

API létrehozása

  1. A bal oldali menü API-k területén válassza az API-kat.

  2. Válassza az + API hozzáadása lehetőséget.

  3. Válassza ki a HTTP-csempét :

    Az Azure Portal HTTP-csempéjének képernyőképe.

  4. Adja meg a háttérbeli webszolgáltatás URL-címét (például https://httpbin.org) és az API egyéb beállításait. A beállításokat az Az első API importálása és közzététele oktatóanyag ismerteti.

  5. Válassza a Létrehozás lehetőséget.

Jelenleg nincsenek API Management-beli műveletek, amelyek összekapcsolódnának a háttér API műveleteivel. Ha olyan műveletet hív meg, amely a háttérrendszeren keresztül van közzétéve, de nem az API Managementen keresztül, 404-es hibaüzenet jelenik meg.

Megjegyzés

Ha hozzáad egy API-t, akkor is, ha egy háttérszolgáltatáshoz csatlakozik, az API Management nem tesz közzé semmilyen műveletet, amíg nem engedélyezi őket. A háttérszolgáltatás működésének engedélyezéséhez hozzon létre egy API Management-műveletet, amely leképezi a háttérműveletet.

Művelet hozzáadása és tesztelése

Ez a szakasz bemutatja, hogyan adhat hozzá egy /get műveletet a háttér művelethez http://httpbin.org/get való hozzárendeléshez.

Művelet hozzáadása

  1. Válassza ki az előző lépésben létrehozott API-t.
  2. Válassza a + Művelet hozzáadása menüpontot.
  3. Az URL-címben válassza a GET elemet, és írja be a /get szöveget a szövegmezőbe.
  4. A Megjelenítendő név mezőbe írja be a FetchData nevet.
  5. Válassza a Mentés lehetőséget.

A művelet tesztelése

Tesztelje a műveletet az Azure Portalon. (A fejlesztői portálon is tesztelheti.)

  1. Kattintson a Teszt fülre.
  2. Válassza a FetchData elemet.
  3. Válassza a Küldés lehetőséget.

A művelet által http://httpbin.org/get generált válasz a HTTP-válasz szakaszban jelenik meg. A műveletek átalakításáról az API átalakítását és védelmét ismertető témakörben olvashat.

Paraméteres művelet hozzáadása és tesztelése

Ez a szakasz bemutatja, hogyan adhat hozzá egy paramétert használó műveletet. Ebben a példában a műveletet a következőre http://httpbin.org/status/200képezheti le:

Művelet hozzáadása

  1. Válassza ki a korábban létrehozott API-t.
  2. A Tervezés lapon válassza a + Művelet hozzáadása lehetőséget.
  3. Az URL-címben válassza a GET elemet, és írja be a /status/{code} kifejezést a szövegmezőbe.
  4. A Megjelenítendő név mezőbe írja be a GetStatus nevet.
  5. Válassza a Mentés lehetőséget.

A művelet tesztelése

Tesztelje a műveletet az Azure Portalon. (A fejlesztői portálon is tesztelheti.)

  1. Kattintson a Teszt fülre.

  2. Válassza a GetStatus elemet. A kódban adja meg a 200 értéket.

  3. Válassza a Küldés lehetőséget.

    A művelet által http://httpbin.org/status/200 generált válasz a HTTP-válasz szakaszban jelenik meg. A műveletek átalakításáról az API átalakítását és védelmét ismertető témakörben olvashat.

Helyettesítő karakter művelet hozzáadása és tesztelése

Ez a szakasz bemutatja, hogyan adhat hozzá egy helyettesítő karakter műveletet. A helyettesítő karakterek használatával tetszőleges értéket adhat át egy API-kéréssel. Ahelyett, hogy külön GET-műveleteket hozna létre az előző szakaszokban látható módon, létrehozhat egy helyettesítő GET műveletet.

Figyelemfelhívás

Legyen óvatos, amikor helyettesítő műveletet konfigurál. Ez a konfiguráció sebezhetőbbé teheti az API-t bizonyos API-biztonsági fenyegetésekkel szemben.

Művelet hozzáadása

  1. Válassza ki a korábban létrehozott API-t.
  2. A Tervezés lapon válassza a + Művelet hozzáadása lehetőséget.
  3. Az URL-címben válassza a GET elemet, és írja be /a * értéket a szövegmezőbe.
  4. A Megjelenítendő név mezőbe írja be a WildcardGet-et.
  5. Válassza a Mentés lehetőséget.

A művelet tesztelése

Tesztelje a műveletet az Azure Portalon. (A fejlesztői portálon is tesztelheti.)

  1. Kattintson a Teszt fülre.

  2. Válassza a WildcardGet elemet. Próbálja ki az előző szakaszokban tesztelt GET műveleteket, vagy próbálkozzon egy másik támogatott GET művelettel.

    A Sablon paramétereiben például módosítsa a helyettesítő karakter (*) neve melletti értéket fejlécekre. A művelet a bejövő kérelem HTTP-fejléceit adja vissza.

  3. Válassza a Küldés lehetőséget.

    A művelet által http://httpbin.org/headers generált válasz a HTTP-válasz szakaszban jelenik meg. A műveletek átalakításáról az API átalakítását és védelmét ismertető témakörben olvashat.

Megjegyzés

Fontos lehet megérteni, hogy az integrálandó háttérrendszer API kiszolgálója hogyan kezeli a művelet URL-címén található záró perjeleket. További információkért tekintse meg az API Managementtel kapcsolatos gyakori kérdéseket.

Egyéb API-k hozzáfűzése

Az API-kat különböző szolgáltatások által közzétett API-kból állíthatja össze, többek között a következőket:

  • OpenAPI-specifikáció
  • A SOAP alkalmazásprogramozási felület
  • A GraphQL programozási interfész (API)
  • Az Azure App Service-ben üzemeltetett webalkalmazás
  • Azure Functions
  • Azure Logic Apps
  • Azure Service Fabric

Megjegyzés

Api importálásakor a műveletek hozzá lesznek fűzve az aktuális API-hoz.

API hozzáfűzése egy meglévő API-hoz:

  1. Nyissa meg az Azure API Management-példányt az Azure Portalon:

    Képernyőkép az API Management-szolgáltatások oldalról.

  2. Válassza az API-k lehetőséget az Áttekintés lapon, vagy válassza az API-k>API-k opciót a bal oldali menüben.

    Képernyőkép, amelyen az API-k kiválasztása látható az Áttekintés lapon.

  3. Jelölje ki a három pontot (...) azon API mellett, amelyhez hozzá szeretne fűzni egy másik API-t.

  4. Válassza a Importálás lehetőséget a legördülő menüből:

    Képernyőkép az Importálás parancsról.

  5. Válasszon egy szolgáltatást, amelyből importálni fogja az API-t.

Kapcsolódó tartalom

  • Last updated on