Memetakan API tahapan ke nama domain khusus untuk REST APIs - APIGerbang Amazon
Permintaan perutean APIPembatasanBuat API pemetaan

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Memetakan API tahapan ke nama domain khusus untuk REST APIs

Anda menggunakan API pemetaan untuk menghubungkan API tahapan ke nama domain kustom. Setelah Anda membuat nama domain dan mengonfigurasi DNS catatan, Anda menggunakan API pemetaan untuk mengirim lalu lintas ke Anda APIs melalui nama domain kustom Anda.

APIPemetaan menentukanAPI, tahap, dan opsional jalur yang akan digunakan untuk pemetaan. Misalnya, Anda dapat memetakan production tahap API tohttps://api.example.com/orders.

Anda dapat memetakan HTTP dan REST API tahapan ke nama domain kustom yang sama.

Sebelum Anda membuat API pemetaan, Anda harus memilikiAPI, panggung, dan nama domain khusus. Untuk mempelajari selengkapnya tentang membuat nama domain kustom, lihatSiapkan nama domain kustom Regional di API Gateway.

Permintaan perutean API

Anda dapat mengonfigurasi API pemetaan dengan beberapa level, misalnya orders/v1/items dan. orders/v2/items

catatan

Untuk mengonfigurasi API pemetaan dengan beberapa level, Anda harus menggunakan nama domain kustom Regional dengan kebijakan keamanan TLS 1.2.

Untuk API pemetaan dengan beberapa level, API Gateway merutekan permintaan ke API pemetaan yang memiliki jalur pencocokan terpanjang. APIGateway hanya mempertimbangkan jalur yang dikonfigurasi untuk API pemetaan, dan bukan API rute, untuk memilih yang akan dipanggilAPI. Jika tidak ada jalur yang cocok dengan permintaan, API Gateway mengirimkan permintaan ke API yang telah Anda petakan ke jalur (none) kosong.

Untuk nama domain kustom yang menggunakan API pemetaan dengan beberapa level, API Gateway merutekan permintaan ke API pemetaan yang memiliki awalan pencocokan terpanjang.

Misalnya, pertimbangkan nama domain khusus https://api.example.com dengan API pemetaan berikut:

  1. (none)dipetakan ke API 1.

  2. ordersdipetakan ke API 2.

  3. orders/v1/itemsdipetakan ke API 3.

  4. orders/v2/itemsdipetakan ke API 4.

  5. orders/v2/items/categoriesdipetakan ke API 5.

Permintaan Dipilih API Penjelasan

https://api.example.com/orders

API 2

Permintaan sama persis dengan API pemetaan ini.

https://api.example.com/orders/v1/items

API 3

Permintaan sama persis dengan API pemetaan ini.

https://api.example.com/orders/v2/items

API 4

Permintaan sama persis dengan API pemetaan ini.

https://api.example.com/orders/v1/items/123

API 3

APIGateway memilih pemetaan yang memiliki jalur pencocokan terpanjang. 123Pada akhir permintaan tidak mempengaruhi pemilihan.

https://api.example.com/orders/v2/items/categories/5

API 5

APIGateway memilih pemetaan yang memiliki jalur pencocokan terpanjang.

https://api.example.com/customers

API 1

APIGateway menggunakan pemetaan kosong sebagai catch-all.

https://api.example.com/ordersandmore

API 2

APIGateway memilih pemetaan yang memiliki awalan pencocokan terpanjang. Untuk nama domain khusus yang dikonfigurasi dengan pemetaan tingkat tunggal, seperti hanya https://api.example.com/orders danhttps://api.example.com/, API Gateway akan memilihAPI 1, karena tidak ada jalur yang cocok dengannya. ordersandmore

Pembatasan

  • Dalam API pemetaan, nama domain khusus dan dipetakan APIs harus berada di akun yang sama AWS .

  • APIpemetaan harus hanya berisi huruf, angka, dan karakter berikut:. $-_.+!*'()/

  • Panjang maksimum untuk jalur dalam API pemetaan adalah 300 karakter.

  • Anda dapat memiliki 200 API pemetaan dengan beberapa level untuk setiap nama domain.

  • Anda hanya dapat memetakan HTTP APIs ke nama domain kustom regional dengan kebijakan keamanan TLS 1.2.

  • Anda tidak dapat memetakan WebSocket APIs ke nama domain kustom yang sama dengan HTTP API atau RESTAPI.

Buat API pemetaan

Untuk membuat API pemetaan, Anda harus terlebih dahulu membuat nama domain kustom,API, dan panggung. Untuk informasi tentang membuat nama domain kustom, lihatSiapkan nama domain kustom Regional di API Gateway.

Misalnya AWS Serverless Application Model template yang membuat semua sumber daya, lihat Sessions With SAM on GitHub.

AWS Management Console
Untuk membuat API pemetaan

  1. Masuk ke konsol API Gateway di https://console.aws.amazon.com/apigateway.

  2. Pilih Nama domain khusus.

  3. Pilih nama domain kustom yang sudah Anda buat.

  4. Pilih APIpemetaan.

  5. Pilih Konfigurasi API pemetaan.

  6. Pilih Tambahkan pemetaan baru.

  7. Masukkan API, Panggung, dan secara opsional Path.

  8. Pilih Simpan.

AWS CLI

AWS CLI Perintah berikut membuat API pemetaan. Dalam contoh ini, API Gateway mengirimkan permintaan api.example.com/v1/orders ke yang ditentukan API dan tahap.

catatan

Untuk membuat API pemetaan dengan beberapa level, Anda harus menggunakan. apigatewayv2

aws apigatewayv2 create-api-mapping \
    --domain-name api.example.com \
    --api-mapping-key v1/orders \
    --api-id a1b2c3d4 \
    --stage test
AWS CloudFormation

AWS CloudFormation Contoh berikut membuat API pemetaan.

catatan

Untuk membuat API pemetaan dengan beberapa level, Anda harus menggunakan. AWS::ApiGatewayV2

MyApiMapping:
  Type: 'AWS::ApiGatewayV2::ApiMapping'
  Properties:
    DomainName: api.example.com
    ApiMappingKey: 'orders/v2/items'
    ApiId: !Ref MyApi
    Stage: !Ref MyStage