Configuration d'une API régionale dans API Gateway

Lorsque des demandes d'API proviennent principalement d'une instance ou des services EC2 dans la même région que celle où l'API est déployée, un point de terminaison d'API régionale réduit généralement la latence des connexions et est recommandé pour ces scénarios.

Note

Si les clients d'API sont dispersés géographiquement, il peut s'avérer judicieux malgré tout d'utiliser un point de terminaison d'API régional, conjointement avec votre propre distribution Amazon CloudFront, afin de s'assurer qu'API Gateway n'associe pas l'API aux distributions CloudFront contrôlées par le service. Pour de plus amples informations sur ce cas d'utilisation, veuillez consulter Comment configurer API Gateway avec ma propre distribution CloudFront ?.

Pour créer une API régionale, suivez la procédure de création d'une API optimisée pour les périphériques, mais définissez explicitement le type REGIONAL en tant que seule option de l'entrée endpointConfiguration de l'API.

Les rubriques suivantes expliquent comment créer une API régionale à l'aide de la console API Gateway, de la AWS CLI et du SDK AWS pour Javascript pour Node.js.

Création d'une API régionale à l'aide de la console API Gateway

Pour créer une API régionale à l'aide de la console API Gateway

1. Connectez-vous à la console API Gateway à l'adresse https://console.aws.amazon.com/apigateway.

2. Effectuez l’une des actions suivantes :

   • Pour créer votre première API, pour API REST, choisissez Création.

   • Si vous avez déjà créé une API, choisissez Créer une API, puis Création pour API REST.

3. Pour Nom, entrez un nom.

4. (Facultatif) Sous Description, entrez une description.

5. Laissez Type de point de terminaison d'API défini sur Régional.

6. Sélectionnez Create API (Créer une API).

Création d'une API régionale à l'aide de l'AWS CLI

Pour créer une API régional à l'aide de l'AWS CLI, utilisez la commande create-rest-api :

aws apigateway create-rest-api \
        --name 'Simple PetStore (AWS CLI, Regional)' \
        --description 'Simple regional PetStore API' \
        --region us-west-2 \
        --endpoint-configuration '{ "types": ["REGIONAL"] }'

Une réponse positive renvoie une charge utile comparable à la suivante :

{
    "createdDate": "2017-10-13T18:41:39Z",
    "description": "Simple regional PetStore API",
    "endpointConfiguration": {
        "types": "REGIONAL"
    },
    "id": "0qzs2sy7bh",
    "name": "Simple PetStore (AWS CLI, Regional)"
}

À partir de là, vous pouvez suivre les instructions figurant dans Configuration d'une API optimisée pour les périphériques à l'aide des commandes de l' AWS CLI pour configurer des méthodes et des intégrations pour cette API.

Créer une API régionale à l'aide du SDK AWS pour JavaScript

Pour créer une API régionale à l'aide du SDK AWS pour JavaScript :

apig.createRestApi({
	name: "Simple PetStore (node.js SDK, regional)",
	endpointConfiguration: {
		types: ['REGIONAL']
	},
	description: "Demo regional API created using the AWS SDK for node.js",
	version: "0.00.001"
}, function(err, data){
	if (!err) {
		console.log('Create API succeeded:\n', data);
		restApiId = data.id;
	} else {
		console.log('Create API failed:\n', err);
	}
});

Une réponse positive renvoie une charge utile comparable à la suivante :

{
    "createdDate": "2017-10-13T18:41:39Z",
    "description": "Demo regional API created using the AWS SDK for node.js",
    "endpointConfiguration": {
        "types": "REGIONAL"
    },
    "id": "0qzs2sy7bh",
    "name": "Simple PetStore (node.js SDK, regional)"
}

Après avoir appliqué les étapes précédentes, vous pouvez suivre les instructions figurant dans Configuration d'une API optimisée pour les périphériques à l'aide du kit SDK AWS pour Node.js pour configurer des méthodes et des intégrations pour cette API.

Test d'une API régionale

Une fois l'API déployée, le nom d'hôte de l'URL par défaut de l'API régionale est au format suivant :

{restapi-id}.execute-api.{region}.amazonaws.com

L'URL de base pour appeler l'API est semblable à ce qui suit :

https://{restapi-id}.execute-api.{region}.amazonaws.com/{stage}

En supposant que vous configurez les méthodes GET /pets et GET /pets/{petId} dans cet exemple, vous pouvez tester l'API en saisissant les URL suivantes dans un navigateur :

https://0qzs2sy7bh.execute-api.us-west-2.amazonaws.com/test/pets

et

https://0qzs2sy7bh.execute-api.us-west-2.amazonaws.com/test/pets/1

Vous pouvez également utiliser les commandes cURL :

curl -X GET https://0qzs2sy7bh.execute-api.us-west-2.amazonaws.com/test/pets 

and

curl -X GET https://0qzs2sy7bh.execute-api.us-west-2.amazonaws.com/test/pets/2