{"id":26024411,"url":"https://github.com/therealpad/golangapigenerator","last_synced_at":"2026-04-11T13:35:03.681Z","repository":{"id":239830662,"uuid":"800704715","full_name":"TheRealPad/golangApiGenerator","owner":"TheRealPad","description":"Golang server with a config file for routes, data models and database system","archived":false,"fork":false,"pushed_at":"2024-08-11T22:25:09.000Z","size":70,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-08-12T19:46:30.832Z","etag":null,"topics":["api","docker","docker-compose","github-actions","golang","makefile","pipeline"],"latest_commit_sha":null,"homepage":"","language":"Go","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/TheRealPad.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":null,"codemeta":null}},"created_at":"2024-05-14T20:51:05.000Z","updated_at":"2024-08-12T19:46:30.833Z","dependencies_parsed_at":"2024-05-21T00:38:53.658Z","dependency_job_id":"827e99b7-caae-4a95-be7d-33015c119e77","html_url":"https://github.com/TheRealPad/golangApiGenerator","commit_stats":null,"previous_names":["therealpad/golangapitemplate","therealpad/golangapigenerator"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheRealPad%2FgolangApiGenerator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheRealPad%2FgolangApiGenerator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheRealPad%2FgolangApiGenerator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheRealPad%2FgolangApiGenerator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TheRealPad","download_url":"https://codeload.github.com/TheRealPad/golangApiGenerator/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242212090,"owners_count":20090424,"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","docker","docker-compose","github-actions","golang","makefile","pipeline"],"created_at":"2025-03-06T12:33:05.506Z","updated_at":"2025-12-31T00:56:12.366Z","avatar_url":"https://github.com/TheRealPad.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"![Unit test](https://github.com/TheRealPad/golangApiTemplate/actions/workflows/unit-test.yml/badge.svg)\n![Integration test](https://github.com/TheRealPad/golangApiTemplate/actions/workflows/integration-test.yml/badge.svg)\n![Deploy](https://github.com/TheRealPad/golangApiTemplate/actions/workflows/deploy.yml/badge.svg)\n\n![Go](https://img.shields.io/badge/go-%2300ADD8.svg?style=for-the-badge\u0026logo=go\u0026logoColor=white)\n![Docker](https://img.shields.io/badge/docker-%230db7ed.svg?style=for-the-badge\u0026logo=docker\u0026logoColor=white)\n![MongoDB](https://img.shields.io/badge/MongoDB-%234ea94b.svg?style=for-the-badge\u0026logo=mongodb\u0026logoColor=white)\n\n# Go API from config file\n\nCreate a server where you just need a config file, and the program do the rest\n\n## Config\n- server name\n- api port\n- routes (name and HTTP method + describe which part of CRUD it is)\n- data models (name, fields and fields type)\n\n## How to run\n\nBy default, the API is just a basic API with a logger to get the activity on the software\n\nDefault available routes:\n```txt\n- /health               -\u003e GET # display information about start time of the api, number of api calls and data models\n- /health/html          -\u003e GET # display above information in html syntax\n- /health/traffic       -\u003e GET # show all api calls\n- /health/traffic/html  -\u003e GET # display above information in html syntax\n```\n\nIf you're on Unix-like system, you can use the [Makefile](Makefile) to run the Docker in background\n\nIf you can't use the Makefile, you can run:\n```bash\ndocker-compose -f ./config/docker/docker-compose.yml up --build -d\n```\n\nIf you can't use Docker, you can run:\n```bash\ngo run .\n```\n\n## Database\n\nFor now the API only handle MongoDB, you can create a cluster and pass an url looking like that:\n```\nmongodb+srv://username:password@cluster0.k1vyunp.mongodb.net/?retryWrites=true\u0026w=majority\u0026appName=Cluster0\n```\n\nThis is the tutorial I followed to get the url https://www.mongodb.com/docs/drivers/go/current/quick-start/","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftherealpad%2Fgolangapigenerator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftherealpad%2Fgolangapigenerator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftherealpad%2Fgolangapigenerator/lists"}