{"id":19824886,"url":"https://github.com/commongateway/zaakregistratiecomponentapi","last_synced_at":"2025-02-28T16:29:19.145Z","repository":{"id":109791117,"uuid":"503775626","full_name":"CommonGateway/ZaakRegistratieComponentAPI","owner":"CommonGateway","description":null,"archived":false,"fork":false,"pushed_at":"2022-10-28T09:45:26.000Z","size":332,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-01-11T08:51:31.932Z","etag":null,"topics":["api","commonground","gateway","gateway-api","zgw"],"latest_commit_sha":null,"homepage":"","language":"Shell","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/CommonGateway.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,"roadmap":null,"authors":null,"dei":null,"publiccode":"publiccode.yaml","codemeta":null}},"created_at":"2022-06-15T13:23:51.000Z","updated_at":"2022-06-20T11:11:23.000Z","dependencies_parsed_at":"2023-03-24T02:03:34.911Z","dependency_job_id":null,"html_url":"https://github.com/CommonGateway/ZaakRegistratieComponentAPI","commit_stats":{"total_commits":38,"total_committers":5,"mean_commits":7.6,"dds":0.5526315789473684,"last_synced_commit":"2f066fb55ed8848c908ce89151523b36669f00cc"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":"CommonGateway/PetStoreAPI","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CommonGateway%2FZaakRegistratieComponentAPI","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CommonGateway%2FZaakRegistratieComponentAPI/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CommonGateway%2FZaakRegistratieComponentAPI/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CommonGateway%2FZaakRegistratieComponentAPI/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CommonGateway","download_url":"https://codeload.github.com/CommonGateway/ZaakRegistratieComponentAPI/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241181378,"owners_count":19923429,"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":["api","commonground","gateway","gateway-api","zgw"],"created_at":"2024-11-12T11:06:24.604Z","updated_at":"2025-02-28T16:29:19.139Z","avatar_url":"https://github.com/CommonGateway.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Zaak Registratie Component API\n[![Automated Testing](https://github.com/CommonGateway/ZaakRegistratieComponent/actions/workflows/tests.yml/badge.svg)](https://github.com/CommonGateway/ZaakRegistratieComponent/actions/workflows/tests.yml)\n\nA example implementation of a Common Gateway configuration for generating an API. This example has been specifically setup to use as a temple, read more about that under [Using this repositry as a temple](#Using this repositry as a temple).\n\n- [API Defintion (redocly)](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/CommonGateway/ZaakRegistratieComponent/main/OAS.yaml\u0026nocors)\n- [API Defintion (file)](https://github.com/CommonGateway/ZaakRegistratieComponent/blob/main/OAS.yaml)\n- [Publiccode](https://github.com/CommonGateway/ZaakRegistratieComponent/blob/main/publiccode.yaml)\n\n## About Common Gateway configuration files\nRead more..\n\n## Creating your own documentation\nThis Commmon Gateway configuration repository is bassed on [petstore](https://redocly.github.io/redoc/) an example [Open API Specification]([https://redocly.com/docs/openapi/reference-docs-example/overview/](https://swagger.io/specification/)) from our friends at [redocly](https://redocly.com/docs/). In order to create and maintain Open Api Secifications files we recomend using [stoplight](), you can find the stoplight project for Pet Store [here](https://conduction.stoplight.io/docs/pet-store/branches/main/ls7mp80wwy88k-swagger-petstore). For convience purpose a copy of the Pet strore oas is stored in this repository [here](https://github.com/CommonGateway/ZaakRegistratieComponent/blob/main/OAS.yaml).\n\nThe [public code](https://yml.publiccode.tools/) for this ropository was genereted trough the [publiccode yaml editor](https://publiccode-editor.developers.italia.it/).\n\n## Running the API locally\n\nYou need [Docker desktop](https://www.docker.com/) if you want to use this API locally on the [gateway](https://github.com/ConductionNL/commonground-gateway).\nOnce you have installed docker you need to go to the root of the project with a command line.\n\nThen you can run the image with:\n\n`docker compose up`\n\nIf the php container shows \"Ready to handle connections\" the gateway is ready.\nThe API runs on port :80 and the endpoints of this API fall under /api\n\n## Running the API online\n\nTo run the API on a online gateway the helm secret PUBLICCODE must be set with the url to the raw publiccode.yaml, like: https://raw.githubusercontent.com/CommonGateway/PetStoreAPI/main/publiccode.yaml\n\nIf its properly set you can run the following command in a PHP pod:\n\n`bin/console app:load-publiccodes`\n\nThe console should show if the API has been loaded successfully, and then you can make API requests to yourdomain/api.\n\n\n## (Unit) Testing the API\n\nOn every commit github launches a action that generates a postman collection and tests the API. Its results can be viewed under Actions on the github page.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcommongateway%2Fzaakregistratiecomponentapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcommongateway%2Fzaakregistratiecomponentapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcommongateway%2Fzaakregistratiecomponentapi/lists"}