{"id":34632817,"url":"https://github.com/excelliumsa/apigateway-study","last_synced_at":"2026-05-27T15:03:13.430Z","repository":{"id":74725738,"uuid":"356793506","full_name":"ExcelliumSA/APIGateway-Study","owner":"ExcelliumSA","description":"Contains the materials used for the blog post about the testing of the API Gateway configuration.","archived":false,"fork":false,"pushed_at":"2023-11-15T13:26:38.000Z","size":17635,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":5,"default_branch":"main","last_synced_at":"2023-11-15T14:34:05.376Z","etag":null,"topics":["api","api-gateway","security","web"],"latest_commit_sha":null,"homepage":"https://excellium-services.com/2021/09/20/how-to-automatically-validate-the-configuration-of-your-api-gateway/","language":"Python","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ExcelliumSA.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2021-04-11T07:06:01.000Z","updated_at":"2023-10-28T08:12:40.000Z","dependencies_parsed_at":null,"dependency_job_id":"6a992682-dbdc-4dbd-8df5-471b8b3968b1","html_url":"https://github.com/ExcelliumSA/APIGateway-Study","commit_stats":null,"previous_names":[],"tags_count":0,"template":null,"template_full_name":null,"purl":"pkg:github/ExcelliumSA/APIGateway-Study","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ExcelliumSA%2FAPIGateway-Study","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ExcelliumSA%2FAPIGateway-Study/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ExcelliumSA%2FAPIGateway-Study/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ExcelliumSA%2FAPIGateway-Study/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ExcelliumSA","download_url":"https://codeload.github.com/ExcelliumSA/APIGateway-Study/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ExcelliumSA%2FAPIGateway-Study/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33570993,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-05-27T02:00:06.184Z","response_time":53,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","api-gateway","security","web"],"created_at":"2025-12-24T16:54:05.599Z","updated_at":"2026-05-27T15:03:13.425Z","avatar_url":"https://github.com/ExcelliumSA.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# APIGateway-Study\n\nContains the materials used for the blog post about the testing of the API Gateway configuration.\n\n# Blog post link\n\nhttps://excellium-services.com/2021/09/20/how-to-automatically-validate-the-configuration-of-your-api-gateway/\n\n# Study note\n\n\u003e :information_source: Download the PDF file to enable the links inside the PDF.\n\nSee file [study-note.pdf](study-note.pdf) to access to the full study note gathered and used for the demo as well as the blog post.\n\n# Execute the lab\n\n\u003e Once launched, the API Gateway ([APIMAN](https://www.apiman.io)) web UI will be available on http://localhost:8080/apimanui/api-manager with creds `admin` / `admin123!`.\n\n\u003e Keycloack authentication part will be available on http://localhost:8080/auth with the same creds.\n\n\u003e Lab requires [docker and docker-compose](https://docs.docker.com/get-docker/) as well as a Internet connection.\n\n*Step 1*\n\nDownload a copy of this repository.\n\n*Step 2:*\n\nUse the following set of commands:\n\n```powershell\nPS\u003e docker-compose up --build --detach\nPS\u003e docker run --rm -it righettod/demo-test-apigtw /bin/bash\n$ curl -Lsk https://[DOCKER_HOST_IP]:8443/apimanui/api-manager | grep -ic \"apiman\"\n# Ensure that result of the command above is different from zero. \n# Otherwise, wait a few seconds, and relaunch the command...\n# If you only want to initialize the API Gateway without running the demo \n# then type: python import-config.py [DOCKER_HOST_IP]:8443 \n$ bash run.sh [DOCKER_HOST_IP]:8443\n$ exit\nPS\u003e docker-compose down\nPS\u003e docker ps -a\n```\n\n# Manually call the lab API\n\n\u003e Use `pip install httpie` to install the [http client used](https://httpie.io/docs).\n\n## Public API\n\nCall syntax - replace `[BIN_ID]` by the https://requestbin.net BIN identifier:\n\n```shell\n# Call raising a CORS origin not allowed error\n$ http --verify=no \"https://localhost:8443/apiman-gateway/XLM/bin/1.0/[BIN_ID]?a=b\" Origin:https://localhost:8442\n...\n# Valid call\n$ http --verify=no \"https://localhost:8443/apiman-gateway/XLM/bin/1.0/[BIN_ID]?a=b\" Origin:https://localhost:8443\n...\n```\n\n## Published API\n\nCall syntax:\n\n```shell\n# Call raising an missing authentication error\n$ http --verify=no \"https://localhost:8443/apiman-gateway/XLM/blog/1.2/todos/1?apikey=d09e70b2-2abc-47d8-9168-80878e662e6a\"\n...\n# Successful call\n$ http --verify=no -a user:password \"https://localhost:8443/apiman-gateway/XLM/blog/1.2/todos/1?apikey=d09e70b2-2abc-47d8-9168-80878e662e6a\"\n...\n```\n\n# Demonstration\n\nTake a look at [this video](demo.mp4).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fexcelliumsa%2Fapigateway-study","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fexcelliumsa%2Fapigateway-study","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fexcelliumsa%2Fapigateway-study/lists"}