{"id":18778593,"url":"https://github.com/ramsailopal/specmatic","last_synced_at":"2025-12-17T15:30:32.805Z","repository":{"id":191399243,"uuid":"684491273","full_name":"RamSailopal/Specmatic","owner":"RamSailopal","description":"A docker image for Specmatic","archived":false,"fork":false,"pushed_at":"2023-08-29T12:06:29.000Z","size":5,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-12-29T10:20:35.974Z","etag":null,"topics":["openapi","specmatic"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/RamSailopal.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-08-29T08:35:53.000Z","updated_at":"2023-08-29T12:06:58.000Z","dependencies_parsed_at":"2023-08-29T18:54:13.934Z","dependency_job_id":null,"html_url":"https://github.com/RamSailopal/Specmatic","commit_stats":null,"previous_names":["ramsailopal/specmatic"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RamSailopal%2FSpecmatic","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RamSailopal%2FSpecmatic/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RamSailopal%2FSpecmatic/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RamSailopal%2FSpecmatic/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RamSailopal","download_url":"https://codeload.github.com/RamSailopal/Specmatic/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239690074,"owners_count":19681035,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["openapi","specmatic"],"created_at":"2024-11-07T20:16:40.955Z","updated_at":"2025-12-17T15:30:32.755Z","avatar_url":"https://github.com/RamSailopal.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# A docker image for Specmatic\r\n\r\n![example workflow](https://github.com/RamSailopal/Specmatic/actions/workflows/docker.yml/badge.svg)\r\n\r\nThis repo contains a Docker build file for Specmatic as well as examples with local and remote OpenAPI files. \r\n\r\n## Setup\r\n\r\nTo set up a Dockerised Specmatic environment locally, run:\r\n\r\n    git clone https://github.com/RamSailopal/Specmatic.git\r\n    cd Specmatic/Example\r\n    alias specmatic=\"docker run --rm -it -v \"$PWD:/home/Example\" ramb0/specmatic\"\r\n    alias specmatic-serv=\"docker run --rm -it -p 9000:9000 -v \"$PWD:/home/Example\" ramb0/specmatic\"\r\n\r\n## Local OpenAPI file\r\n\r\nAn example OpenAPI file for a simple pets API has been created  - **Example/service.yaml** Another file for \"canned responses\" has been also been created - **Example/scooby.json** \r\n\r\nTo run a \"stub server\" for the API on port 9000, run:\r\n\r\n     specmatic-serv stub service.yaml\r\n\r\nTo test the API, you first need the local network accessible IP address of the host machine:\r\n\r\nLinux -\r\n\r\n    ip add show\r\n\r\nWindows -\r\n\r\n    ipconfig\r\n\r\nOnce this has been attained, run:\r\n\r\n     specmatic test service.yaml --host \u003caddressofhostmachine\u003e\r\n\r\ni.e.\r\n\r\n     specmatic test --host 172.28.61.122 \r\n\r\n## OpenAPI file stored in a separate centralised repo\r\n\r\nReferences to a centralised repo can be made in the setup through the file **Example/specmatic.json**\r\n\r\nAs an example, references to an openAPI file in the Specmatic repo have been made - https://github.com/znsio/specmatic-order-contracts/blob/main/in/specmatic/examples/store/api_order_v1.yaml\r\n\r\nWhen running Specmatic with a specmatic.json configured, there is no need to specify the location of the local OpenAPI file and so, to run the stub command with the process listening on port 9000, use:\r\n\r\n    specmatic-serv stub\r\n\r\nTo run all other processes i.e test, use:\r\n\r\n    specmatic test --host \u003caddressofmachine\u003e\r\n\r\n## References\r\n\r\n**Docker Hub** - https://hub.docker.com/repository/docker/ramb0/specmatic/general\r\n\r\n**Specmatic** - https://github.com/znsio/specmatic-documentation\r\n\r\n**OpenAPI** - https://www.openapis.org/\r\n\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Framsailopal%2Fspecmatic","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Framsailopal%2Fspecmatic","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Framsailopal%2Fspecmatic/lists"}