lap-amazon-api-gateway（LAP amazon API gateway 文档）

Amazon API Gateway

API version: 2015-07-09

Auth

AWS SigV4

Base URL

Not specified.

Setup

1. Configure auth: AWS SigV4
2. GET /account -- verify access
3. POST /apikeys -- create first apikeys

Endpoints

120 endpoints across 11 groups. See references/api-spec.lap for full details.

apikeys

restapis

domainnames

usageplans

vpclinks

clientcertificates

account

sdktypes

tags

apikeys?mode=import

restapis?mode=import

Common Questions

Match user requests to endpoints in references/api-spec.lap. Key patterns:

• "Create a apikey?" -> POST /apikeys
• "Create a authorizer?" -> POST /restapis/{restapi_id}/authorizers
• "Create a basepathmapping?" -> POST /domainnames/{domain_name}/basepathmappings
• "Create a deployment?" -> POST /restapis/{restapi_id}/deployments
• "Create a part?" -> POST /restapis/{restapi_id}/documentation/parts
• "Create a version?" -> POST /restapis/{restapi_id}/documentation/versions
• "Create a domainname?" -> POST /domainnames
• "Create a model?" -> POST /restapis/{restapi_id}/models
• "Create a requestvalidator?" -> POST /restapis/{restapi_id}/requestvalidators
• "Create a restapis?" -> POST /restapis
• "Create a stage?" -> POST /restapis/{restapi_id}/stages
• "Create a usageplan?" -> POST /usageplans
• "Create a key?" -> POST /usageplans/{usageplanId}/keys
• "Create a vpclink?" -> POST /vpclinks
• "Delete a apikey?" -> DELETE /apikeys/{api_Key}
• "Delete a authorizer?" -> DELETE /restapis/{restapi_id}/authorizers/{authorizer_id}
• "Delete a basepathmapping?" -> DELETE /domainnames/{domain_name}/basepathmappings/{base_path}
• "Delete a clientcertificate?" -> DELETE /clientcertificates/{clientcertificate_id}
• "Delete a deployment?" -> DELETE /restapis/{restapi_id}/deployments/{deployment_id}
• "Delete a part?" -> DELETE /restapis/{restapi_id}/documentation/parts/{part_id}
• "Delete a version?" -> DELETE /restapis/{restapi_id}/documentation/versions/{doc_version}
• "Delete a domainname?" -> DELETE /domainnames/{domain_name}
• "Delete a gatewayrespons?" -> DELETE /restapis/{restapi_id}/gatewayresponses/{response_type}
• "Delete a response?" -> DELETE /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration/responses/{status_code}
• "Delete a method?" -> DELETE /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}
• "Delete a response?" -> DELETE /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/responses/{status_code}
• "Delete a model?" -> DELETE /restapis/{restapi_id}/models/{model_name}
• "Delete a requestvalidator?" -> DELETE /restapis/{restapi_id}/requestvalidators/{requestvalidator_id}
• "Delete a resource?" -> DELETE /restapis/{restapi_id}/resources/{resource_id}
• "Delete a restapis?" -> DELETE /restapis/{restapi_id}
• "Delete a stage?" -> DELETE /restapis/{restapi_id}/stages/{stage_name}
• "Delete a usageplan?" -> DELETE /usageplans/{usageplanId}
• "Delete a key?" -> DELETE /usageplans/{usageplanId}/keys/{keyId}
• "Delete a vpclink?" -> DELETE /vpclinks/{vpclink_id}
• "Create a clientcertificate?" -> POST /clientcertificates
• "List all account?" -> GET /account
• "Get apikey details?" -> GET /apikeys/{api_Key}
• "List all apikeys?" -> GET /apikeys
• "Get authorizer details?" -> GET /restapis/{restapi_id}/authorizers/{authorizer_id}
• "List all authorizers?" -> GET /restapis/{restapi_id}/authorizers
• "Get basepathmapping details?" -> GET /domainnames/{domain_name}/basepathmappings/{base_path}
• "List all basepathmappings?" -> GET /domainnames/{domain_name}/basepathmappings
• "Get clientcertificate details?" -> GET /clientcertificates/{clientcertificate_id}
• "List all clientcertificates?" -> GET /clientcertificates
• "Get deployment details?" -> GET /restapis/{restapi_id}/deployments/{deployment_id}
• "List all deployments?" -> GET /restapis/{restapi_id}/deployments
• "Get part details?" -> GET /restapis/{restapi_id}/documentation/parts/{part_id}
• "List all parts?" -> GET /restapis/{restapi_id}/documentation/parts
• "Get version details?" -> GET /restapis/{restapi_id}/documentation/versions/{doc_version}
• "List all versions?" -> GET /restapis/{restapi_id}/documentation/versions
• "Get domainname details?" -> GET /domainnames/{domain_name}
• "List all domainnames?" -> GET /domainnames
• "Get export details?" -> GET /restapis/{restapi_id}/stages/{stage_name}/exports/{export_type}
• "Get gatewayrespons details?" -> GET /restapis/{restapi_id}/gatewayresponses/{response_type}
• "List all gatewayresponses?" -> GET /restapis/{restapi_id}/gatewayresponses
• "List all integration?" -> GET /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration
• "Get response details?" -> GET /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration/responses/{status_code}
• "Get method details?" -> GET /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}
• "Get response details?" -> GET /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/responses/{status_code}
• "Get model details?" -> GET /restapis/{restapi_id}/models/{model_name}
• "List all default_template?" -> GET /restapis/{restapi_id}/models/{model_name}/default_template
• "List all models?" -> GET /restapis/{restapi_id}/models
• "Get requestvalidator details?" -> GET /restapis/{restapi_id}/requestvalidators/{requestvalidator_id}
• "List all requestvalidators?" -> GET /restapis/{restapi_id}/requestvalidators
• "Get resource details?" -> GET /restapis/{restapi_id}/resources/{resource_id}
• "List all resources?" -> GET /restapis/{restapi_id}/resources
• "Get restapis details?" -> GET /restapis/{restapi_id}
• "List all restapis?" -> GET /restapis
• "Get sdk details?" -> GET /restapis/{restapi_id}/stages/{stage_name}/sdks/{sdk_type}
• "Get sdktype details?" -> GET /sdktypes/{sdktype_id}
• "List all sdktypes?" -> GET /sdktypes
• "Get stage details?" -> GET /restapis/{restapi_id}/stages/{stage_name}
• "List all stages?" -> GET /restapis/{restapi_id}/stages
• "Get tag details?" -> GET /tags/{resource_arn}
• "List all usage?" -> GET /usageplans/{usageplanId}/usage
• "Get usageplan details?" -> GET /usageplans/{usageplanId}
• "Get key details?" -> GET /usageplans/{usageplanId}/keys/{keyId}
• "List all keys?" -> GET /usageplans/{usageplanId}/keys
• "List all usageplans?" -> GET /usageplans
• "Get vpclink details?" -> GET /vpclinks/{vpclink_id}
• "List all vpclinks?" -> GET /vpclinks
• "Create a apikeys?mode=import?" -> POST /apikeys?mode=import
• "Create a restapis?mode=import?" -> POST /restapis?mode=import
• "Update a gatewayrespons?" -> PUT /restapis/{restapi_id}/gatewayresponses/{response_type}
• "Update a response?" -> PUT /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration/responses/{status_code}
• "Update a method?" -> PUT /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}
• "Update a response?" -> PUT /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/responses/{status_code}
• "Update a restapis?" -> PUT /restapis/{restapi_id}
• "Update a tag?" -> PUT /tags/{resource_arn}
• "Delete a tag?" -> DELETE /tags/{resource_arn}
• "Partially update a apikey?" -> PATCH /apikeys/{api_Key}
• "Partially update a authorizer?" -> PATCH /restapis/{restapi_id}/authorizers/{authorizer_id}
• "Partially update a basepathmapping?" -> PATCH /domainnames/{domain_name}/basepathmappings/{base_path}
• "Partially update a clientcertificate?" -> PATCH /clientcertificates/{clientcertificate_id}
• "Partially update a deployment?" -> PATCH /restapis/{restapi_id}/deployments/{deployment_id}
• "Partially update a part?" -> PATCH /restapis/{restapi_id}/documentation/parts/{part_id}
• "Partially update a version?" -> PATCH /restapis/{restapi_id}/documentation/versions/{doc_version}
• "Partially update a domainname?" -> PATCH /domainnames/{domain_name}
• "Partially update a gatewayrespons?" -> PATCH /restapis/{restapi_id}/gatewayresponses/{response_type}
• "Partially update a response?" -> PATCH /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration/responses/{status_code}
• "Partially update a method?" -> PATCH /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}
• "Partially update a response?" -> PATCH /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/responses/{status_code}
• "Partially update a model?" -> PATCH /restapis/{restapi_id}/models/{model_name}
• "Partially update a requestvalidator?" -> PATCH /restapis/{restapi_id}/requestvalidators/{requestvalidator_id}
• "Partially update a resource?" -> PATCH /restapis/{restapi_id}/resources/{resource_id}
• "Partially update a restapis?" -> PATCH /restapis/{restapi_id}
• "Partially update a stage?" -> PATCH /restapis/{restapi_id}/stages/{stage_name}
• "Partially update a usageplan?" -> PATCH /usageplans/{usageplanId}
• "Partially update a vpclink?" -> PATCH /vpclinks/{vpclink_id}
• "How to authenticate?" -> See Auth section

Response Tips

• Check response schemas in references/api-spec.lap for field details
• List endpoints may support pagination; check for limit, offset, or cursor params
• Create/update endpoints typically return the created/updated object

CLI

# Update this spec to the latest version
npx @lap-platform/lapsh get amazon-api-gateway -o references/api-spec.lap

# Search for related APIs
npx @lap-platform/lapsh search amazon-api-gateway

References

• Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

Generated from the official API spec by LAP