{"id":42262806,"url":"https://github.com/gvre/api-sample-app","last_synced_at":"2026-01-27T06:09:17.896Z","repository":{"id":57538066,"uuid":"285562643","full_name":"gvre/api-sample-app","owner":"gvre","description":"A simple REST-like API (no HATEOAS) example that can be used as a starter kit.","archived":false,"fork":false,"pushed_at":"2025-08-17T09:16:44.000Z","size":193,"stargazers_count":11,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-01-12T05:34:05.579Z","etag":null,"topics":["docker","docker-compose","go","golang","make","postgresql","rest-api"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gvre.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2020-08-06T12:13:04.000Z","updated_at":"2025-08-17T05:04:49.000Z","dependencies_parsed_at":"2024-06-19T16:02:21.693Z","dependency_job_id":"c4dbf5ad-4b97-43d3-b106-cceaf3b09fe6","html_url":"https://github.com/gvre/api-sample-app","commit_stats":null,"previous_names":["gvre/rest-api-sample-app"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/gvre/api-sample-app","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gvre%2Fapi-sample-app","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gvre%2Fapi-sample-app/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gvre%2Fapi-sample-app/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gvre%2Fapi-sample-app/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gvre","download_url":"https://codeload.github.com/gvre/api-sample-app/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gvre%2Fapi-sample-app/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28805421,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-27T05:43:52.625Z","status":"ssl_error","status_checked_at":"2026-01-27T05:43:48.957Z","response_time":168,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["docker","docker-compose","go","golang","make","postgresql","rest-api"],"created_at":"2026-01-27T06:09:17.261Z","updated_at":"2026-01-27T06:09:17.890Z","avatar_url":"https://github.com/gvre.png","language":"Go","readme":"# REST API Sample Application\n\n## Requirements\n- Docker\n- Docker Compose\n\n## Usage\n- `make help` Display help, and the most useful Makefile targets\n- `make start` Build all containers and start the services\n- `make start_debug` Build container with the application and a debugger\n- `make stop` Stop all containers\n- `make app` Build application container\n- `make app_debug` Build application and debugger container\n- `make clean` Remove any existing containers and volumes of the application\n- `make openapi_validate`  Validate the OpenAPI specification file\n- `make openapi_editor` Start the Swagger Editor (http://localhost:18081/)\n\n## API endpoints\n- `curl http://localhost:18080/-/live` Check if the service is up\n- `curl http://localhost:18080/-/health` Check if the service and its dependencies are up\n- `curl http://localhost:18080/-/metrics` Prometheus metrics\n- `curl http://localhost:18080/users` Return all users\n- `curl http://localhost:18080/users/1` Return the user with ID `1`\n- `curl -H 'Content-type: application/json' http://localhost:18080/users -d '{\"name\":\"new user\"}'` Add a new user\n\n## Testing\n- `make test` Run all tests. Use the TAGS argument to pass specific tags (e.g. `make TAGS=api test`)\n\n## Migrations\nAll database migrations should be backward compatible, so only the `up` ones are needed.\nThe migrations library supports the `down` ones though, in case you want to play with fire :)\n\nSee [MIGRATIONS.md](https://github.com/golang-migrate/migrate/blob/master/MIGRATIONS.md) for more details.\n\n## Architecture\n\u003cpre\u003e┌─────────────┐          ┌─────────────┐          ┌─────────────┐          ┌─────────────┐\n│             ├─────────▶│             │─────────▶│    User     │─────────▶│             │\n│HTTP Handlers│          │User Service │          │ Repository  │          │  Database   │\n│             │◀─────────┤             │◀─────────│             │◀─────────┤             │\n└─────────────┘          └─────────────┘          └─────────────┘          └─────────────┘\u003c/pre\u003e\n\n## License\n- MIT\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgvre%2Fapi-sample-app","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgvre%2Fapi-sample-app","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgvre%2Fapi-sample-app/lists"}