{"id":22192506,"url":"https://github.com/3sidedcube/laravel-redoc","last_synced_at":"2025-08-12T18:38:42.076Z","repository":{"id":56938320,"uuid":"466816384","full_name":"3sidedcube/laravel-redoc","owner":"3sidedcube","description":"A lightweight package for rendering API documentation using OpenAPI and Redoc.","archived":false,"fork":false,"pushed_at":"2024-05-20T11:39:58.000Z","size":20,"stargazers_count":5,"open_issues_count":1,"forks_count":2,"subscribers_count":3,"default_branch":"1.x","last_synced_at":"2024-11-11T11:14:11.296Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/3sidedcube.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","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":"2022-03-06T18:05:00.000Z","updated_at":"2024-10-25T12:38:50.000Z","dependencies_parsed_at":"2024-05-20T12:39:15.134Z","dependency_job_id":"88094885-840c-439b-a0d4-1c437de053d0","html_url":"https://github.com/3sidedcube/laravel-redoc","commit_stats":{"total_commits":10,"total_committers":2,"mean_commits":5.0,"dds":0.09999999999999998,"last_synced_commit":"b689a9c10238c4dd5826d7b0a6ea807ceb60becc"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3sidedcube%2Flaravel-redoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3sidedcube%2Flaravel-redoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3sidedcube%2Flaravel-redoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3sidedcube%2Flaravel-redoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/3sidedcube","download_url":"https://codeload.github.com/3sidedcube/laravel-redoc/tar.gz/refs/heads/1.x","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227726349,"owners_count":17810452,"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":[],"created_at":"2024-12-02T12:25:39.453Z","updated_at":"2024-12-02T12:25:40.125Z","avatar_url":"https://github.com/3sidedcube.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://3sidedcube.com\" target=\"_blank\"\u003e\n        \u003cimg src=\"https://3sidedcube.com/app/themes/tsc-2018/img/footer/logo-black.png\" width=\"400\" alt=\"3 Sided Cube\"\u003e\n    \u003c/a\u003e\n\u003c/p\u003e\n\n# Laravel Redoc\n\n[![Latest Version on Packagist](https://img.shields.io/packagist/v/3sidedcube/laravel-redoc.svg?style=flat-square)](https://packagist.org/packages/3sidedcube/laravel-redoc)\n[![Total Downloads](https://img.shields.io/packagist/dt/3sidedcube/laravel-redoc.svg?style=flat-square)](https://packagist.org/packages/3sidedcube/laravel-redoc)\n![GitHub Actions](https://github.com/3sidedcube/laravel-redoc/actions/workflows/run-tests.yml/badge.svg)\n\nThis package provides an easy way for rendering API documentation using OpenAPI and Redoc.\n\n## Installation\n\nYou can install the package via composer:\n\n```bash\ncomposer require 3sidedcube/laravel-redoc\n```\n\n## Usage\n\n### Viewing the documentation\n\nBy default, the documentation is served at `/docs/api` and will load the `openapi.json` file from the `openapi` folder\nat the root of the project.\n\nYou can change the path used to serve the documentation by setting the `redoc.path` config option.\n\nIf you would like to change the directory where your `openapi.json` file is located, you can update `redoc.directory`\nconfig option. \n\n### Documentation versions\n\nLaravel Redoc supports rendering multiple versions of documentation. If you would like to serve a different version of\nthe documentation, you can include `{version}` in the `redoc.path` config option e.g. `docs/{version}/api`. This will\nthen load the `{version}.json` file from the configured directory.\n\n### Variables\n\nIf you would like to replace a \"variable\" in the documentation, you can use the `redoc.variables` config option.\n\nFor example, if you would like to dynamically set the server url to the given environment, you could configure the\nfollowing variable:\n\n```php\n'variables' =\u003e [\n    'server_url' =\u003e env('APP_URL'),\n],\n```\n\nNow, when you use `:server_url` in the OpenAPI definition, it will be replaced with the value of the `APP_URL`.\n\n## Testing\n\n```bash\ncomposer test\n```\n\n## Changelog\n\nPlease see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.\n\n## Contributing\n\nPlease see [CONTRIBUTING](CONTRIBUTING.md) for details.\n\n## Credits\n\n-   [Ben Sherred](https://github.com/benshered)\n-   [All Contributors](../../contributors)\n\n## License\n\nLaravel Redoc is open-sourced software licensed under the [MIT license](LICENSE.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F3sidedcube%2Flaravel-redoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F3sidedcube%2Flaravel-redoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F3sidedcube%2Flaravel-redoc/lists"}