{"id":19765078,"url":"https://github.com/azhovan/standard-json-response","last_synced_at":"2025-10-19T09:23:26.798Z","repository":{"id":110798304,"uuid":"107756310","full_name":"Azhovan/Standard-Json-Response","owner":"Azhovan","description":"Standard Json Response","archived":false,"fork":false,"pushed_at":"2017-10-24T06:37:47.000Z","size":7,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-02-28T10:39:07.293Z","etag":null,"topics":["api","api-server","json","json-api","response"],"latest_commit_sha":null,"homepage":"","language":null,"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/Azhovan.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":"2017-10-21T06:14:44.000Z","updated_at":"2017-10-21T07:04:57.000Z","dependencies_parsed_at":null,"dependency_job_id":"6e8e69a7-03bb-40a4-8c76-35427bec9532","html_url":"https://github.com/Azhovan/Standard-Json-Response","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Azhovan/Standard-Json-Response","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Azhovan%2FStandard-Json-Response","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Azhovan%2FStandard-Json-Response/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Azhovan%2FStandard-Json-Response/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Azhovan%2FStandard-Json-Response/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Azhovan","download_url":"https://codeload.github.com/Azhovan/Standard-Json-Response/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Azhovan%2FStandard-Json-Response/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262981070,"owners_count":23394460,"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","api-server","json","json-api","response"],"created_at":"2024-11-12T04:16:35.312Z","updated_at":"2025-10-19T09:23:21.749Z","avatar_url":"https://github.com/Azhovan.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Standard-Json-Response\nThis document identify how a standard Json API response should be.\n please feel free to contribute !\n\n\n##### Full structure of response :\n```\n{\n\t\"data\": {...},\n\t\"errors\": {...},\n\t\"meta\": {...}\n}\n```\n\n##### Resource Objects:\n```\n   {\n \t\"type\": \"articles\",\n \t\"id\": \"1\",\n \t\"attributes\": {\n \t\t\"title\": \"Rails is Omakase\",\n \t\t\"price\": 25000\n \t},\n \t\"relationships\": {\n \t\t\"author\": {\n \t\t\t\"links\": {\n \t\t\t\t\"self\": \"/articles/1/relationships/author\",\n \t\t\t\t\"related\": \"/articles/1/author\"\n \t\t\t},\n \t\t\t\"data\": {\n \t\t\t\t\"type\": \"people\",\n \t\t\t\t\"id\": \"9\"\n \t\t\t},\n \t\t\t\"meta\": {}\n \t\t}\n \t},\n \t\"Links\": {\n \t\t\"self\": \"http://example.com/posts\",\n \t\t\"related\": {\n \t\t\t\"href\": \"http://example.com/articles/1/comments\",\n \t\t\t\"meta\": {\n \t\t\t\t\"count\": 10\n \t\t\t}\n \t\t}\n\n\n \t},\n \t\"meta\": {\n \t\t\"copyright\": \"Copyright 2015 Example Corp.\",\n \t\t\"authors\": [\n \t\t\t\"Yehuda Katz\",\n \t\t\t\"Steve Klabnik\",\n \t\t\t\"Dan Gebhardt\",\n \t\t\t\"Tyler Kellen\"\n \t\t]\n \t}\n }\n```\n\n#### Error Object :  \n\n```text\n{\n\t\"errors\": [{\n\t\t\"id\": 1,\n\t\t\"links\": {\n\t\t\t\"about\": \"http://thisis.com/link/about/the/problem\"\n\t\t},\n\t\t\"status\": 400,\n\t\t\"code\": \"application code here\",\n\t\t\"title\": \"title of error\",\n\t\t\"details\": \"\",\n\t\t\"source\": {\n\t\t\t\"pointer\": \"requested uri\",\n\t\t\t\"parameter\": \"uri query strings\"\n\t\t},\n\t\t\"meta\": {}\n\t}]\n}\n```\n\n##### Relationships Object:\n```text\n\"relationships\": {\n    \"author\": {\n        \"links\": {\n            \"self\": \"/articles/1/relationships/author\",\n            \"related\": \"/articles/1/author\"\n        },\n        \"data\": {\n            \"type\": \"people\",\n            \"id\": \"9\"\n        },\n        \"meta\": {}\n    }\n}\n```\n\n#### Links Object :\n```text\n\"Links\": {\n    \"self\": \"http://example.com/posts\",\n    \"related\": {\n        \"href\": \"http://example.com/articles/1/comments\",\n        \"meta\": {\n            \"count\": 10\n        }\n    }\n\n\n}\n```\n\n#### Meta Object :\n```text\n\"meta\": {\n    \"copyright\": \"Copyright 2015 Example Corp.\",\n    \"authors\": [\n        \"Yehuda Katz\",\n        \"Steve Klabnik\",\n        \"Dan Gebhardt\",\n        \"Tyler Kellen\"\n    ]\n}\n```\n#### useful links \n```\nhttps://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md\nhttps://geemus.gitbooks.io/http-api-design/content/en/\nhttps://byrondover.github.io/post/restful-api-guidelines/\nhttps://medium.com/@shazow/how-i-design-json-api-responses-71900f00f2db\nhttps://phalt.co/api-response-formats/\nhttp://editor.swagger.io/#/\n\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fazhovan%2Fstandard-json-response","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fazhovan%2Fstandard-json-response","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fazhovan%2Fstandard-json-response/lists"}