{"id":22013172,"url":"https://github.com/kolirt/laravel-api-response","last_synced_at":"2025-05-06T21:43:57.987Z","repository":{"id":57008167,"uuid":"170815372","full_name":"kolirt/laravel-api-response","owner":"kolirt","description":"⭐️ Unification of API responses for Laravel projects inspired by telegram api responses","archived":false,"fork":false,"pushed_at":"2024-09-08T09:01:23.000Z","size":73,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"v3","last_synced_at":"2025-04-17T10:42:08.829Z","etag":null,"topics":["api","api-response","api-responser","json-response","laravel","rest-api"],"latest_commit_sha":null,"homepage":"","language":"PHP","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/kolirt.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.txt","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},"funding":{"custom":"https://www.buymeacoffee.com/kolirt"}},"created_at":"2019-02-15T06:46:25.000Z","updated_at":"2024-09-08T09:01:26.000Z","dependencies_parsed_at":"2024-08-19T19:17:46.127Z","dependency_job_id":"2091ab5a-1c28-4a8a-aed5-872b0058e0af","html_url":"https://github.com/kolirt/laravel-api-response","commit_stats":{"total_commits":22,"total_committers":1,"mean_commits":22.0,"dds":0.0,"last_synced_commit":"52730d98257d58e80fd920c02403bfb0f4b1ae76"},"previous_names":[],"tags_count":19,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kolirt%2Flaravel-api-response","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kolirt%2Flaravel-api-response/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kolirt%2Flaravel-api-response/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kolirt%2Flaravel-api-response/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kolirt","download_url":"https://codeload.github.com/kolirt/laravel-api-response/tar.gz/refs/heads/v3","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252776253,"owners_count":21802459,"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-response","api-responser","json-response","laravel","rest-api"],"created_at":"2024-11-30T03:17:52.156Z","updated_at":"2025-05-06T21:43:57.930Z","avatar_url":"https://github.com/kolirt.png","language":"PHP","funding_links":["https://www.buymeacoffee.com/kolirt"],"categories":[],"sub_categories":[],"readme":"# Laravel Api Response\nUnification of API responses for Laravel projects inspired by telegram api responses\n\n\u003cp align=\"center\"\u003e\n    \u003cimg src=\"https://raw.githubusercontent.com/kolirt/laravel-api-response/v3/cover.png\"\u003e\n\u003c/p\u003e\n\n\n## Structure\n- [Getting started](#getting-started)\n  - [Requirements](#requirements) \n  - [Installation](#installation)\n- [Usage](#usage)\n    - [Example](#example)\n      - [Error response](#error-response)\n      - [Success response](#success-response)\n    -  [Methods](#methods)\n       - [error](#error)\n       - [success](#success)\n       - [setCode](#setcode)\n       - [setDescription](#setdescription)\n       - [setErrors](#seterrors)\n       - [abort](#abort)\n       - [cookie](#cookie)\n       - [setData](#setdata)\n       - [render](#render)\n- [FAQ](#faq)\n- [License](#license)\n- [Other packages](#other-packages)\n\n\u003ca href=\"https://www.buymeacoffee.com/kolirt\" target=\"_blank\"\u003e\n  \u003cimg src=\"https://cdn.buymeacoffee.com/buttons/v2/arial-yellow.png\" alt=\"Buy Me A Coffee\" style=\"height: 60px !important;width: 217px !important;\" \u003e\n\u003c/a\u003e\n\n\n## Getting started\n\n### Requirements\n- PHP \u003e= 8.1\n- Laravel \u003e= 10\n\nFor lesser versions of Laravel or PHP, use the [v2](https://github.com/kolirt/laravel-api-response/tree/v2)\n\n\n### Installation\n```bash\ncomposer require kolirt/laravel-api-response\n```\n\n\n## Usage\n\n### Example\n\n#### Error response\n```php\nreturn api()\n        -\u003eerror()\n        -\u003esetCode(400) // default code 400\n\n        -\u003esetDescription(['Description #1', 'Description #2'])\n        // or\n        -\u003esetDescription('Description')\n        \n        -\u003esetData(['Data #1', 'Data #2'])\n        // or\n        -\u003esetData('Data')\n        \n        -\u003erender();\n```\n\n```php\n[\n    'ok' =\u003e false,\n    'error_code' =\u003e 400,\n    \n    'description' =\u003e ['Description #1', 'Description #2'],\n    // or\n    'description' =\u003e 'Description',\n    \n    'result' =\u003e ['Data #1', 'Data #2'],\n    // or\n    'result' =\u003e 'Data',\n]\n```\n\n\n#### Success response\n```php\nreturn api()\n        -\u003esuccess()\n        -\u003esetCode(200) // default code 200\n\n        -\u003esetDescription(['Description #1', 'Description #2'])\n        // or\n        -\u003esetDescription('Description #1')\n        \n        -\u003esetData(['Data #1', 'Data #2'])\n        // or\n        -\u003esetData('Data')\n        \n        -\u003erender();\n```\n\n```php\n[\n    'ok' =\u003e true,\n    \n    'description' =\u003e ['Description #1', 'Description #2'],\n    // or\n    'description' =\u003e 'Description',\n    \n    'result' =\u003e ['Data #1', 'Data #2'],\n    // or\n    'result' =\u003e 'Data',\n]\n```\n\n\n### Methods\n\n#### `error`\nMark response as error\n\n```php\nreturn api()-\u003eerror();\n```\n\n\n#### `success`\nMark response as success\n\n```php\nreturn api()-\u003esuccess();\n```\n\n\n#### `setCode`\nSet specific code to response. Available [codes](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes)\n\n```php\nreturn api()-\u003esetCode($code);\n```\n\n\n#### `setDescription`\nAdd description to response\n\n```php\nreturn api()-\u003esetDescription(['Description #1', 'Description #2']);\n// or\nreturn api()-\u003esetDescription('Description');\n```\n\n\n#### `setErrors`\nAdd errors to response\n\n```php\nreturn api()-\u003esetErrors([\n    'first_name' =\u003e 'Error message', \n    'last_name' =\u003e ['Error message 1', 'Error message 2']\n]);\n```\n\n\n#### `abort`\nAbort response with error\n\n```php\nreturn api()-\u003eabort('Error message', 400);\n```\n\n\n#### `cookie`\nAdd cookie to response\n\n```php\nreturn api()-\u003ecookie(cookie('token', 'asdsadsadas', 60 * 3));\n```\n\n\n#### `setData`\nAdd data to response\n\n```php\nreturn api()-\u003esetData(['Data #1', 'Data #2']);\n// or\nreturn api()-\u003esetData('Data');\n```\n\n\n#### `render`\nRender response\n\n```php\nreturn api()-\u003erender();\n```\n\n\n## FAQ\nCheck closed [issues](https://github.com/kolirt/laravel-api-response/issues) to get answers for most asked questions\n\n\n## License\n[MIT](LICENSE.txt)\n\n\n## Other packages\nCheck out my other packages on my [GitHub profile](https://github.com/kolirt)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkolirt%2Flaravel-api-response","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkolirt%2Flaravel-api-response","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkolirt%2Flaravel-api-response/lists"}