{"id":18796039,"url":"https://github.com/dees040/laravel-api-responses","last_synced_at":"2025-04-13T15:41:50.276Z","repository":{"id":23436866,"uuid":"99001153","full_name":"dees040/laravel-api-responses","owner":"dees040","description":"Return readable API responses","archived":false,"fork":false,"pushed_at":"2024-04-15T13:52:13.000Z","size":21,"stargazers_count":69,"open_issues_count":0,"forks_count":5,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-04-10T07:43:59.595Z","etag":null,"topics":["api","laravel","php","response"],"latest_commit_sha":null,"homepage":"","language":"PHP","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/dees040.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}},"created_at":"2017-08-01T12:53:51.000Z","updated_at":"2024-11-02T17:40:23.000Z","dependencies_parsed_at":"2024-04-15T15:27:29.167Z","dependency_job_id":"8678988e-2957-472a-9c79-f97237ef380d","html_url":"https://github.com/dees040/laravel-api-responses","commit_stats":{"total_commits":27,"total_committers":5,"mean_commits":5.4,"dds":0.2222222222222222,"last_synced_commit":"c09255238d26a83a9bd9bcdd969a0eb1cbb78228"},"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dees040%2Flaravel-api-responses","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dees040%2Flaravel-api-responses/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dees040%2Flaravel-api-responses/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dees040%2Flaravel-api-responses/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dees040","download_url":"https://codeload.github.com/dees040/laravel-api-responses/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248739968,"owners_count":21154247,"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","laravel","php","response"],"created_at":"2024-11-07T21:36:13.779Z","updated_at":"2025-04-13T15:41:50.252Z","avatar_url":"https://github.com/dees040.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Laravel API Responses\n\n\u003cp align=\"center\"\u003e\n\u003ca href=\"https://packagist.org/packages/dees040/laravel-api-responses\"\u003e\u003cimg src=\"https://poser.pugx.org/dees040/laravel-api-responses/v/stable\" alt=\"Latest Stable Version\"\u003e\u003c/a\u003e\n\u003ca href=\"https://packagist.org/packages/dees040/laravel-api-responses\"\u003e\u003cimg src=\"https://poser.pugx.org/dees040/laravel-api-responses/downloads\" alt=\"Total Downloads\"\u003e\u003c/a\u003e\n\u003ca href=\"https://travis-ci.org/dees040/laravel-api-responses\"\u003e\u003cimg src=\"https://travis-ci.org/dees040/laravel-api-responses.svg?branch=master\" alt=\"Build status\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\nA very small package which helps you to easily returning readable API responses.\n\n## Installation\n\nInstall the package via Composer.\n\n```bash\ncomposer require dees040/laravel-api-responses\n```\n\nYou're ready to go!\n\n## Usage\n\nJust use one of the helper functions and you're good to go.\n\n```php\n\u003c?php\n\nnamespace App\\Http\\Controllers;\n\nuse App\\User;\nuse App\\Http\\Controllers\\Controller;\n\nclass UsersController extends Controller\n{\n    /**\n     * Show the given user.\n     *\n     * @param  \\App\\User  $user\n     * @return \\Illuminate\\Http\\Response\n     */\n    public function show(User $user)\n    {\n        if (! $user-\u003eisAdmin()) {\n            return forbidden();\n        }\n        \n        return ok($user);\n    }\n}\n```\n\n## Methods\n\nAll methods accept a `$data` parameter. This can be any data which can be used in a JSON response, such as strings, integers, arrays, models, etc..\n\n| Method                                    | Status Code   |\n| ----------------------------------------- |:-------------:|\n| `ok($data)`                               | 200           |\n| `created($data)`                          | 201           |\n| `accepted($data)`                         | 202           |\n| `no_content()`                            | 204           |\n| `bad_request($message, $errors)`          | 400           |\n| `unauthenticated($message, $errors)`      | 401           |\n| `forbidden($message, $errors)`            | 403           |\n| `not_found($message, $errors)`            | 404           |\n| `method_not_allowed($message, $errors)`   | 405           |\n| `not_acceptable($message, $errors)`       | 406           |\n| `teapot($message, $errors)`               | 418           |\n| `unprocessable_entity($message, $errors)` | 422           |\n\n### Custom response (code)\n\nIf you'd wish to send a status code which is not in the list you could use the `json_response($data = null, $status = 200)` helper function. [Here](https://www.cheatography.com/kstep/cheat-sheets/http-status-codes/) you can find a cheat sheet for HTTP status codes or use my personal favorite [http.cat](https://http.cat) 😉.\n\nIf you want to send error response you can use the `error_json_response($message = '', $errors = [], $status = 400)`. This method will send an json response like this:\n\n```php\nerror_json_response('User not found.', [\n    'id' =\u003e 'The ID does not exists.'\n]);\n```\n\nOutput:\n\n```json\n{\n  \"message\": \"User not found.\",\n  \"errors\": {\n    \"id\": \"The ID does not exists.\"\n  }\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdees040%2Flaravel-api-responses","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdees040%2Flaravel-api-responses","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdees040%2Flaravel-api-responses/lists"}