API hozzáadása manuálisan

A KÖVETKEZŐRE VONATKOZIK: Minden API Management-szint

Ez a cikk egy API manuális hozzáadásának lépéseit mutatja be az API Management-példányhoz. Ha ki szeretné gúnyolni az API-t, létrehozhat egy üres API-t, vagy manuálisan definiálhatja. További részletek az API-k szimulálásáról: API-válaszok szimulálása.

Ha egy meglévő API-t szeretne importálni, tekintse meg a kapcsolódó témaköröket.

Ebben a cikkben létrehozunk egy üres API-t, és a httpbin.org (nyilvános tesztelési szolgáltatás) definiáljuk háttér API-ként.

Előfeltételek

Végezze el a következő rövid útmutatót: Azure API Management-példány létrehozása

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

1. Az Azure Portalon keresse meg és válassza ki az API Management-szolgáltatásokat.

   

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

   

API létrehozása

1. Lépjen az API Management szolgáltatásra az Azure Portalon, és válassza ki az API-kat a menüből.
2. A bal oldali menüben válassza az + API hozzáadása elemet.
3. Válassza ki a HTTP-t a listából.
   
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 első API-oktatóanyag importálása és közzététele ismerteti.
5. Válassza a Létrehozás lehetőséget.

Jelenleg nincs olyan művelete az API Managementben, amely megfelelteti a háttér API műveleteit. Ha olyan műveletet hív meg, amely a háttérrendszeren keresztül érhető el, de nem az API Managementen keresztül, 404-es értéket kap.

Feljegyzés

Ha hozzáad egy API-t, akkor is, ha valamilyen 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 "http://httpbin.org/get" Művelet.

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 lehetőséget.
3. Az URL-címben válassza a GET elemet, és adja meg /get az erőforrást.
4. A Megjelenített név mezőbe írja be a következőt: „FetchData”.
5. Válassza a Mentés lehetőséget.

Műveletek 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. Kattintson a Küldés gombra.

A válasz, hogy a "http://httpbin.org/get" művelet jön létre. 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 az esetben a műveletet a következőre képezzük le: "http://httpbin.org/status/200".

A 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 lehetőséget.
3. Az URL-címben válassza a GET elemet, és adja meg /status/{code} az erőforrást. Lehetősége van megadni a paraméterhez kapcsolódó információkat. A TÍPUS értéke például lehet „Szám”, az ÉRTÉKEK értéke pedig lehet „200” (az alapértelmezett érték).
4. A Megjelenített név mezőbe írja be a következőt: „GetStatus”.
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ód alapértelmezett értéke „200”. Ezt szabadon módosíthatja, ha más értékeket is tesztelne. Írja be például, hogy „418”.

3. Kattintson a Küldés gombra.

   A válasz, hogy a "http://httpbin.org/status/200" művelet jön létre. 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ő karakterek hozzáadása és tesztelése

Ez a szakasz bemutatja, hogyan adhat hozzá helyettesítő karaktereket. 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

Használjon ápolást helyettesítő karakterek konfigurálásakor. Ez a konfiguráció sebezhetőbbé teheti az API-t bizonyos API-biztonsági fenyegetésekkel szemben.

A 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 lehetőséget.
3. Az URL-címben válassza a GET elemet, és adja meg /* az erőforrást.
4. Adja meg a "Helyettesítő karakter" kifejezést a megjelenítendő névhez.
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 Helyettesítő karakterget lehetőséget. 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 Sablonparaméterekben például frissítse a helyettesítő karakter (*) neve melletti értéket a következőreheaders: . A művelet a bejövő kérelem HTTP-fejléceit adja vissza.

3. Kattintson a Küldés gombra.

   A válasz, hogy a "http://httpbin.org/headers" művelet jön létre. A műveletek átalakításáról az API átalakítását és védelmét ismertető témakörben olvashat.

Feljegyzés

Fontos lehet megérteni, hogy az integrálandó háttér API gazdagépe hogyan fogópontokkal záró perjeleket a művelet URL-címén. További információkért tekintse meg az API Managementtel kapcsolatos gyakori kérdéseket.

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

Különböző szolgáltatások által közzétett API-kat készíthet, többek között az alábbiakat:

• OpenAPI-specifikáció
• A SOAP API
• A GraphQL API
• A Azure-alkalmazás Service-ben üzemeltetett webalkalmazás
• Azure-függvényalkalmazás
• Azure Logic Apps
• Azure Service Fabric

Fűzjön hozzá egy másik API-t a meglévő API-hoz az alábbi lépésekkel.

Feljegyzés

Egy másik API importálásakor a műveletek hozzáfűződnek az aktuális API-hoz.

1. Nyissa meg az Azure API Management-példányát az Azure Portalon.

   

2. Válassza az API-kat az Áttekintés lapon vagy a bal oldali menüben.

   

3. Kattintson a ... elemre azon API mellett, amelyhez egy másik API-t szeretne hozzáfűzni.

4. Válassza az Importálás elemet a legördülő menüből.

   

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

   

Kapcsolódó témakörök

• API-importálási korlátozások
• OpenAPI-specifikáció importálása
• SOAP API importálása
• SOAP API importálása és konvertálása REST-té
• App Service API importálása
• Container App API importálása
• WebSocket API importálása
• GraphQL API-k importálása
• GraphQL-sémák importálása és mezőfeloldók beállítása
• Azure-függvényalkalmazás importálása
• Azure Logic App-alkalmazás importálása
• Service Fabric-szolgáltatás importálása
• Azure OpenAI API importálása
• OData API importálása
• SAP OData-metaadatok importálása
• GRPC API importálása
• API szerkesztése

Következő lépések

Közzétett API átalakítása és védelme