{"id":23107006,"url":"https://github.com/mrjoops/api-project-template","last_synced_at":"2026-04-19T14:36:50.192Z","repository":{"id":41770763,"uuid":"207814788","full_name":"mrjoops/api-project-template","owner":"mrjoops","description":null,"archived":false,"fork":false,"pushed_at":"2023-01-07T09:36:55.000Z","size":1506,"stargazers_count":0,"open_issues_count":24,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-09T10:30:56.264Z","etag":null,"topics":["api","openapi","rest"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/mrjoops.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}},"created_at":"2019-09-11T13:06:20.000Z","updated_at":"2019-09-27T12:12:51.000Z","dependencies_parsed_at":"2023-02-06T19:45:48.929Z","dependency_job_id":null,"html_url":"https://github.com/mrjoops/api-project-template","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrjoops%2Fapi-project-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrjoops%2Fapi-project-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrjoops%2Fapi-project-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrjoops%2Fapi-project-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mrjoops","download_url":"https://codeload.github.com/mrjoops/api-project-template/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247092374,"owners_count":20882217,"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","openapi","rest"],"created_at":"2024-12-17T01:12:05.035Z","updated_at":"2026-04-19T14:36:45.168Z","avatar_url":"https://github.com/mrjoops.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# API project template\n\n## Usage\n\n1. Fork this repository\n2. Write your API descriptions in OpenAPI v3 YAML format in a file named `openapi.yaml`\n3. Place them in a folder named after your service, and under the `reference` folder\n4. Delete `reference/.gitignore`\n\n### Validate API descriptions\n\nRun this command:\n\n```\nmake check\n```\n\n### Combine API descriptions\n\nJust run this command:\n\n```\nmake\n```\n\nPaths are prefixed with the base name of the description file, so if you have a `GET /:id` operation in your `reference/user/openapi.yaml` description file, it will be transformed into a `GET /user/:id` operation.\n\n### Upload combined API description\n\nYou can define `UPLOAD_URL` if you don't want to send your file to Bitbucket (otherwise you just have to define `BB_AUTH_STRING`), then run this command:\n\n```\nmake upload\n```\n\n### Generate documentation\n\nDocumentation will be generated in the `doc` folder using this command:\n\n```\nmake doc\n```\n\n### Publish documentation to Netlify\n\nYou must define `NETLIFY_AUTH_TOKEN` and `NETLIFY_SITE_ID` first, then run this command:\n\n```\nmake publish\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmrjoops%2Fapi-project-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmrjoops%2Fapi-project-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmrjoops%2Fapi-project-template/lists"}