localstack / localstack/serverless-localstack
Static API Gateway V1 Endpoints
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 542
- Forks
- 92
- PR merge metrics
- No merged PRs in 30d
Description
Hi team 👋
### Context
My project is using localstack + severless.
I have my lambda function and I want to deploy to the localstack environment. After I deployed successfully, I find out that the endpoints (check screenshot below) is printing out in the stdout with a random rest-api-id (from the screenshot it is **q7yho9op8e**)
I cannot find a localstack-severless documentation to teach me how to have the static URL (since the above rest-api-id keep changing after each localstack deployment)
But I found this [localstack doc](https://docs.localstack.cloud/user-guide/aws/apigateway/), which provides a way to have the static URL by passing the tag '_custom_id_ ' to localstack api creation.

I also found that there is a way to pass the tag to the Api Gateway V1 by following this [serverless doc](https://www.serverless.com/framework/docs/providers/aws/events/apigateway#tags--stack-tags)

### Test Process
1. spin up the localstack by run command `localstack start`
2. deploy the lambda to localstack by running `sls deploy --stage local --config serverless.local.yml`
3. check endpoints from sls deploy stdout
### Expected
I am expecting the api endpoint should looks like
http://localhost:4566/restapis/tagsMyId123/local/_user_request_ or http://localhost:4566/restapis/stackTagsMyId123/local/_user_request_
### Actual
As the result, the URL is still not static after deployment with tag set in the severless.yml (check screenshot below)
### Questions:
1. Does localstack-serverless plugin support the feature that mentioned in the localstack doc?
5. Is there a way I can have the static URL since I need the static URL to run my e2e testing.
Many thanks 🙏
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Reproduce the deployment with `localstack start` and `sls deploy --stage local --config serverless.local.yml`, using the tags shown in `serverless.yml`. Compare the generated API Gateway V1 endpoint across deployments and inspect the plugin entry points involved in API creation. Done means determining whether the requested static URL is supported and documenting or implementing the required behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- api
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100