A CORS engedélyezése interaktív konzolhoz az API Management fejlesztői portálján

A KÖVETKEZŐKRE VONATKOZIK: Fejlesztő | Alapcsomag | Alapcsomag v2 | Standard | Standard v2 | Prémium | Prémium v2

A forrásközi erőforrás-megosztás (CORS) egy HTTP-fejlécalapú mechanizmus, amely lehetővé teszi a kiszolgáló számára, hogy minden olyan forrást (tartományt, sémát vagy portot) jelezzon, amely nem a sajátja, amelyről a böngészőnek engedélyeznie kell az erőforrások betöltését.

Ha engedélyezni szeretné, hogy az API Management fejlesztői portál látogatói az API referenciaoldalain az interaktív tesztkonzolt használják, engedélyezze a CORS-szabályzatot api-k számára az API Management-példányban. Ha a fejlesztői portál tartományneve nem a tartományközi API-kérések engedélyezett forrása, a tesztkonzol felhasználói CORS-hibát fognak látni.

Bizonyos esetekben a fejlesztői portált CORS-proxyként konfigurálhatja ahelyett, hogy cors-szabályzatot engedélyezn az API-khoz.

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 portálonkeresse meg és válassza ki a API Management szolgáltatásokat:

   

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

   

CORS-szabályzat engedélyezése API-khoz

Engedélyezheti, hogy a CORS-szabályzat automatikusan konfigurálható legyen az API Management-példány összes API-jában. A CORS-szabályzatokat manuálisan is konfigurálhatja.

Megjegyzés

A rendszer csak egy CORS-szabályzatot hajt végre. Ha több CORS-szabályzatot ad meg (például AZ API szintjén és a teljes API-k szintjén), előfordulhat, hogy az interaktív konzol nem a várt módon működik.

CORS-szabályzat automatikus engedélyezése

1. Az API Management-példány bal oldali menüjében, a Fejlesztői portál területen válassza a Portál áttekintése lehetőséget.
2. A CORS engedélyezése területen megjelenik a CORS-szabályzatkonfiguráció állapota. A figyelmeztető mező egy hiányzó vagy helytelenül konfigurált szabályzatot jelez.
3. Ha a CORS-t a fejlesztői portálon szeretné engedélyezni az összes API-hoz, válassza a CORS engedélyezése lehetőséget.

CORS-szabályzat manuális engedélyezése

1. A létrehozott szabályzatkód megtekintéséhez válassza a Manuálisan alkalmazza globálisan hivatkozást.
2. Az API Management-példány API-k szakaszában lépjen az Összes API-ra.
3. Válassza a </> ikont a Bejövő feldolgozás szakaszban.
4. A szabályzatszerkesztőbe szúrja be a szabályzatot az <XML-fájl bejövő> szakaszában. Győződjön meg arról, hogy a <forrás> értéke megegyezik a fejlesztői portál tartományával.

Megjegyzés

Ha a CORS-szabályzatot a Termék hatókörben alkalmazza az API(k) hatóköre helyett, és az API egy fejlécen keresztül használja az előfizetési kulcs hitelesítését, a konzol nem fog működni.

A böngésző automatikusan kiad egy HTTP-kérést OPTIONS , amely nem tartalmaz fejlécet az előfizetési kulccsal. A hiányzó előfizetési kulcs miatt az API Management nem tudja társítani a OPTIONS hívást egy termékkel, így nem tudja alkalmazni a CORS-szabályzatot.

Áthidaló megoldásként átadhatja az előfizetési kulcsot egy lekérdezési paraméterben.

CORS-konfiguráció egyéni tartománynévhez

Ha egyéni tartományt konfigurál a fejlesztői portálhoz, és azt szeretné, hogy a látogatók api-referencialapokon használják a tesztkonzolt, győződjön meg arról, hogy engedélyezi a CORS-t az egyéni fejlesztői portál tartományneve számára.

Az egyéni tartomány konfigurálásakor engedélyezheti, hogy egy beállítás forrást adjon hozzá az egyéni fejlesztői portál tartományához a CORS-szabályzatban. Ha a CORS már engedélyezve lett az alapértelmezett tartományhoz, mindkét forrás szerepel a CORS-szabályzatban. A CORS-szabályzat beállításait bármikor módosíthatja.

CORS proxy-beállítás

Bizonyos esetekben (például ha az API Management-átjáró hálózati elkülönítésben van), a fejlesztői portált cors-proxyként konfigurálhatja ahelyett, hogy cors-szabályzatot engedélyez az API-k számára. A CORS-proxy az interaktív konzol API-hívásait a portál háttérrendszerén keresztül irányítja át az API Management-példányban.

Megjegyzés

Ha az API-k egy saját üzemeltetésű átjárón keresztül érhetők el, vagy a szolgáltatás egy virtuális hálózaton található, az API Management fejlesztői portál háttérszolgáltatásából az átjáróhoz való kapcsolódás szükséges.

A CORS-proxy konfigurálásához rendszergazdaként lépjen a fejlesztői portálra:

1. Az API Management-példány Áttekintés lapján válassza a Fejlesztői portál lehetőséget. A fejlesztői portál egy új böngészőlapon nyílik meg.
2. A felügyeleti felület bal oldali menüjében válassza a Pages>API-k>részletei lehetőséget.
3. Az API-k: Részletek lapon válassza a Művelet: Részletek widgetet, és válassza a Vezérlő szerkesztése lehetőséget.
4. Válassza a CORS-proxy használata lehetőséget.
5. Mentse a módosításokat a portálon, és tegye közzé újra a portált.

CORS-konfiguráció saját üzemeltetésű fejlesztői portálhoz

Ha önkiszolgálóként üzemelteti a fejlesztői portált, a CORS engedélyezéséhez a következő konfigurációra van szükség:

• Adja meg a portál háttérvégpontját a backendUrl konfigurációs fájlokban található beállítással. Ellenkező esetben a saját üzemeltetésű portál nem ismeri a háttérszolgáltatás helyét.

• Adja hozzá az Origin tartomány értékeit a saját üzemeltetésű portál konfigurációhoz, megadva azokat a környezeteket, ahol a saját üzemeltetésű portál üzemel. További információ

Kapcsolódó tartalom

• A szabályzatok konfigurálásával kapcsolatos további információkért lásd: Szabályzatok beállítása vagy szerkesztése.
• A CORS-szabályzattal kapcsolatos részletekért tekintse meg a cors-szabályzat referenciáit .