{"id":24211882,"url":"https://github.com/kasunben/json-api-spec","last_synced_at":"2026-02-16T02:34:41.110Z","repository":{"id":42738001,"uuid":"282430881","full_name":"heimdallrj/json-api-spec","owner":"heimdallrj","description":"A minimalistic specification for building RESTful APIs in JSON ","archived":false,"fork":false,"pushed_at":"2022-12-13T09:31:58.000Z","size":135,"stargazers_count":4,"open_issues_count":5,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-04-25T10:02:40.198Z","etag":null,"topics":["api-spec","documentation","json","json-api","mock-server","restful-api"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/heimdallrj.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}},"created_at":"2020-07-25T11:33:05.000Z","updated_at":"2020-09-07T18:13:23.000Z","dependencies_parsed_at":"2023-01-28T10:31:34.487Z","dependency_job_id":null,"html_url":"https://github.com/heimdallrj/json-api-spec","commit_stats":null,"previous_names":["heimdallrj/json-api-spec","thinkholic/json-api-spec"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/heimdallrj%2Fjson-api-spec","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/heimdallrj%2Fjson-api-spec/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/heimdallrj%2Fjson-api-spec/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/heimdallrj%2Fjson-api-spec/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/heimdallrj","download_url":"https://codeload.github.com/heimdallrj/json-api-spec/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":233835578,"owners_count":18737699,"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-spec","documentation","json","json-api","mock-server","restful-api"],"created_at":"2025-01-14T02:37:24.889Z","updated_at":"2025-09-22T08:32:19.379Z","avatar_url":"https://github.com/heimdallrj.png","language":"JavaScript","readme":"# json:api:spec\n\nA minimalistic specification for building RESTful APIs in JSON.\n\nThis project inspired after [{json:api}](https://jsonapi.org/)\n\n**{json:api}** is one of the best API specifications we have around. The intention of this project isn't competing but proposing more of a minimalistic, but scalable API specification which can apply to build RESTful APIs.\n\n## SPEC\n\nThis project is still in early stage. The idea is documenting every aspect of building RESTful APIs in the manner of minimalistic and scalable to fit for any kind of need.\n\nSuggestions, comments are highly appreciated.\n\nCheck the [SPEC](https://github.com/thinkholic/json-api-spec/blob/master/SPEC.md).\n\n## MockServer\n\nGet up and running a MockAPIServer (based on proposed specification) with zero coding.\n\nCheck [README](https://github.com/thinkholic/json-api-spec/blob/master/mock-server/README.md) for detailed explaination.\n\n_________________\n\nHere's an example JSON Response:\n\n```\nGET /articles HTTP/1.1\nContent-Type: application/json\nAccept: application/json\nX-Request-ID: ?\n\n{\n  \"data\": [\n    {\n      \"id\": \"1\",\n      \"title\": \"Hello World!\",\n      \"summary\": \"Neque porro quisquam est qui dolorem\",\n      \"body\": \"Neque porro **quisquam** est qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit\",\n      \"images\": [\n        {\n          \"url\": \"https://cdn.example.com/hello.png\",\n          \"alt\": \"Hello!\"\n        }\n      ],\n      \"timestamp\": \"Sat, 25 Jul 2020 13:24:57 GMT\",\n      \"authors\": {\n        \"data\": [\n          {\n            \"id\": \"11\",\n            \"first_name\": \"John\",\n            \"last_name\": \"Doe\",\n            \"endpoints\": {\n              \"extends\": \"/authors/11\"\n            }\n          }\n        ],\n        \"endpoints\": {\n          \"explicit\": \"/articles/1/authors/\"\n        }\n      },\n      \"comments\": {\n        \"data\": [\n          {\n            \"id\": \"12\",\n            \"body\": \"Nice writeup!\",\n            \"author\": {\n              \"id\": \"121\",\n              \"name\": \"Jane Doe\",\n              \"avatar\": \"https://cdn.example.com/users/jane-doe.png\",\n              \"endpoints\": {\n                \"extends\": \"/users/121\"\n              }\n            },\n            \"endpoints\": {\n              \"extends\": \"/comments/12\"\n            }\n          }\n        ],\n        \"endpoints\": {\n          \"explicit\": \"/articles/1/comments/\"\n        }\n      },\n      \"endpoints\": {\n        \"explicit\": \"/articles/1\"\n      }\n    }\n  ],\n  \"endpoints\": {\n    \"self\": \"/articles\",\n    \"next\": \"/articles?limit=20\u0026offset=21\"\n  }\n}\n```\n\n[![CC0 1.0 Universal (CC0 1.0)\nPublic Domain Dedication](https://mirrors.creativecommons.org/presskit/buttons/88x31/svg/cc-zero.svg)](https://creativecommons.org/publicdomain/zero/1.0/)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkasunben%2Fjson-api-spec","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkasunben%2Fjson-api-spec","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkasunben%2Fjson-api-spec/lists"}