[{"type":"blog","content":"\r\n## TL:DR\r\n\r\n```bash\r\nhttps://{restapi_id}.execute-api.{region}.amazonaws.com/{stage_name}/\r\n```\r\n\r\nThe `restapi_id` is the API ID found in API Gateway on the AWS Management Console, pictured below. Remember that each deployment you have will have an API ID set up for it. So your `test` API ID won't be the same as your `prod` API.\r\n\r\n $\"Image$ \r\n\r\nI put in the closest `region` for me (`us-east-1`), but that can be any region. \r\n\r\nThen you put in the stage the API is deployed to. So `prod`, `dev`, `test`, or whatever environments you have set up.\r\n\r\nAnd that's it. There's a more extensive conversation about permissions, deployments, etc. I might have that conversation on this blog. Stay tuned.\r\n\r\n-George","frontmatter":{"title":"How to Call A Deployed API Endpoint in Amazon API Gateway","subtitle":"Snippit used for calling API endpoints","description":"Snippit used for calling API endpoints","slug":"how-to-call-a-deployed-api-endpoint-in-amazon-api-gateway","tags":["note","aws"],"category":"dev-blog","image":null,"date":"2023-02-01T00:00:00.000Z","canonical":"https://georgeoffley.com/how-to-call-a-deployed-api-endpoint-in-amazon-api-gateway"},"title":"How to Call A Deployed API Endpoint in Amazon API Gateway","subtitle":"Snippit used for calling API endpoints","description":"Snippit used for calling API endpoints ","category":"dev-blog","tags":["note","aws"],"canonical":"https://georgeoffley.com/how-to-call-a-deployed-api-endpoint-in-amazon-api-gateway","slug":"how-to-call-a-deployed-api-endpoint-in-amazon-api-gateway","date":"2023-02-01T00:00:00.000Z","readingTime":"1 minute","ghMetadata":{"issueUrl":"https://github.com/georgeoffley/george-offley-blog-swyxkit/issues/4","commentsUrl":"https://api.github.com/repos/georgeoffley/george-offley-blog-swyxkit/issues/4/comments","title":"How to Call A Deployed API Endpoint in Amazon API Gateway","created_at":"2023-02-01T21:59:10Z","updated_at":"2023-04-14T13:25:17Z","reactions":{"url":"https://api.github.com/repos/georgeoffley/george-offley-blog-swyxkit/issues/4/reactions","total_count":0,"+1":0,"-1":0,"laugh":0,"hooray":0,"confused":0,"heart":0,"rocket":0,"eyes":0}}},{"type":"blog","content":"\r\n## TL;DR\r\n\r\nAmazon API Gateway only allows for one path variable per resource. So these endpoints work:\r\n\r\n- `/user/{id}/update-status`\r\n- `/user/{id}/search-user`\r\n\r\nThese will throw an error since I already have the `id` as a path variable, and trying to set another is a Nah dawg.\r\n\r\n- `/user/{id}/update-status`\r\n- `/user/{id}/search-user`\r\n- `/user/{status}`\r\n\r\nThe error is this:\r\n\r\n```bash\r\nAn error occurred: ApiGatewayResourceChecksIdVar - A sibling ({id}) of this resource already has a variable path part -- only one is allowed.\r\n```\r\n\r\n

\r\n\r\n## More Context\r\n\r\nSo today, while charging full speed into a deliverable deadline, I spent an hour tracking down why my deployment to AWS kept failing. So, for some context, I'm making API endpoints for an internal tool at work. \r\n\r\nSo to work, I wrote the [Cloudformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html) files for the new feature I was adding, only to run into an error with my deployment.\r\n\r\nIn my case, we had a resource for `/user` with a bunch of endpoints under it. Like so: \r\n\r\n- `/user/{id}/update-status`\r\n- `/user/{id}/search-user`\r\n\r\n If you notice the `{id}` in those endpoints, those are [path variables](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-routes.html#http-api-routes-path-variables). These let us pass information into the API call. In the case above, we use them to pass in a user's ID to know which user to perform an action.\r\n\r\nFor this new feature I was working on, I needed to add the ability to create users with a specific `user-status`; my solution was to make an endpoint where the `user-status` was passed in via a path variable. Like so:\r\n\r\n`/user/{status}`\r\n\r\n## The Problem\r\n\r\nAPI Gateway didn't like that one bit and threw this error when I deployed:\r\n\r\n```bash\r\nAn error occurred: ApiGatewayResourceChecksIdVar - A sibling ({id}) of this resource already has a variable path part -- only one is allowed.\r\n```\r\n\r\nIt turns out [API Gateway only allows one path variable per resource](https://forum.serverless.com/t/api-gateway-similar-routes-different-methods-problem/7014), and my `user` resource already had the `id` path variable, so API Gateway threw an error when trying to set another. \r\n\r\n## Figuring It Out\r\n\r\nThis problem was easily solvable since it was a [`POST`](https://www.restapitutorial.com/lessons/httpmethods.html) endpoint, and I would send a body of `JSON` data to it. So my solution was to add the status to the request payload. I know a little more about API Gateway; hopefully, you do too!\r\n\r\n-George","frontmatter":{"title":"AWS API Gateway Resources","subtitle":null,"description":null,"slug":"aws-api-gateway-resources","tags":["note","aws"],"category":"dev-blog","image":null,"date":"2023-01-07T00:00:00.000Z","canonical":"https://georgeoffley.com/aws-api-gateway-resources"},"title":"AWS API Gateway Resources","subtitle":null,"description":"## TL;DR ","category":"dev-blog","tags":["note","aws"],"canonical":"https://georgeoffley.com/aws-api-gateway-resources","slug":"aws-api-gateway-resources","date":"2023-01-07T00:00:00.000Z","readingTime":"2 minutes","ghMetadata":{"issueUrl":"https://github.com/georgeoffley/george-offley-blog-swyxkit/issues/2","commentsUrl":"https://api.github.com/repos/georgeoffley/george-offley-blog-swyxkit/issues/2/comments","title":"AWS API Gateway Resources","created_at":"2023-01-08T02:19:16Z","updated_at":"2023-04-14T13:30:04Z","reactions":{"url":"https://api.github.com/repos/georgeoffley/george-offley-blog-swyxkit/issues/2/reactions","total_count":0,"+1":0,"-1":0,"laugh":0,"hooray":0,"confused":0,"heart":0,"rocket":0,"eyes":0}}},{"type":"blog","content":"\r\n### Introduction \r\n\r\nRecently, I was experimenting with system testing on a new stack. While working with [Selenium Remote Driver](https://www.selenium.dev/documentation/webdriver/remote_webdriver/) to create [headless web browsers](https://en.wikipedia.org/wiki/Headless_browser) (more on that later) to run against my app, I came across a Docker option I had not known. This Docker feature allowed for easily accessible and fast file reading and writing between the host and the container. It was being used as a volume, but I learned it was much more. When I looked it up, it was referred to as a [*Shared Memory Device*](https://en.wikipedia.org/wiki/Shared_memory).\r\n\r\n\r\n\r\n### Shared Memory Device \r\n\r\nTurns out that this is an old Linux staple. The shared memory device, located in the `/dev/shm/` directory in the file system, utilizes temporary storage using RAM rather than disk storage. Using a shared volume available on the RAM and not the disk makes for a much faster read/write speeds. These devices also allows for [inter-process communication](https://en.wikipedia.org/wiki/Inter-process_communication).\r\n\r\n### Use in Docker \r\n\r\nDocker allows for the use of this device. When conducting my testing, I used the volume mapping feature to easily map local directories with directories inside the containers we’re working on. As seen below.\r\n\r\n```bash\r\ndocker run --rm -it -v /dev/shm/:/dev/shm/ --name ubuntu ubuntu\r\n```\r\n\r\nThis mapped the local shared memory device to the Docker device. Docker, by default, allows for up to 64 MB of storage space using the shared memory device. You can see the default allocation when searching for the shared storage device within the container. As seen below.\r\n\r\n```bash\r\n$ docker inspect ubuntu | grep -i shm\r\n \"ShmSize\": 67108864,\r\n```\r\n\r\nI was saving screenshots just to ensure that I was looking at the thing I was hoping to look at. Although I was only doing some foundational work, I could find myself in a pickle with only 64 MB of space available if this work ends up scaling. Should we need to, Docker lets us change the size of this device using the *--shm-size* option. As seen below.\r\n\r\n```bash\r\ndocker run --rm -it -v /dev/shm/:/dev/shm --shm-size=2gb --name ubuntu ubuntu\r\n```\r\n\r\nAbove we add in the *--shm-size* option and we can specify all the space we need! Let’s look one more time to confirm that it works.\r\n\r\n```bash\r\n$ docker inspect ubuntu | grep -i shm\r\n \"ShmSize\": 2147483648,\r\n```\r\n\r\nShazam! We have more storage in our shared memory device to play around with.\r\n\r\n### Conclusion \r\n\r\nThere is more to come about my adventures in Dockerizing system testing, but for now, I was able to learn a new thing about Linux and Docker. I hope it helps someone who came across it without knowing as I did.\r\n\r\n-George","frontmatter":{"title":"Shared Memory in Docker","subtitle":null,"description":null,"slug":"shared-memory-in-docker","tags":["note","docker"],"category":"dev-blog","image":null,"date":"2023-01-07T00:00:00.000Z","canonical":"https://georgeoffley.com/shared-memory-in-docker"},"title":"Shared Memory in Docker","subtitle":null,"description":"### Introduction ","category":"dev-blog","tags":["note","docker"],"canonical":"https://georgeoffley.com/shared-memory-in-docker","slug":"shared-memory-in-docker","date":"2023-01-07T00:00:00.000Z","readingTime":"2 minutes","ghMetadata":{"issueUrl":"https://github.com/georgeoffley/george-offley-blog-swyxkit/issues/1","commentsUrl":"https://api.github.com/repos/georgeoffley/george-offley-blog-swyxkit/issues/1/comments","title":"Shared Memory in Docker","created_at":"2023-01-07T20:49:14Z","updated_at":"2023-04-14T13:31:08Z","reactions":{"url":"https://api.github.com/repos/georgeoffley/george-offley-blog-swyxkit/issues/1/reactions","total_count":0,"+1":0,"-1":0,"laugh":0,"hooray":0,"confused":0,"heart":0,"rocket":0,"eyes":0}}}]

George Offley Blog

Most Popular

Shared Memory in Docker

Working with Context in Go

Context In React

All Posts