PHPackages                             3sidedcube/laravel-redoc - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. 3sidedcube/laravel-redoc

ActiveLibrary[API Development](/categories/api)

3sidedcube/laravel-redoc
========================

A lightweight package for rendering API documentation using OpenAPI and Redoc.

v1.0.1(2y ago)536.1k—3.6%3[1 PRs](https://github.com/3sidedcube/laravel-redoc/pulls)MITPHPPHP ^7.4|^8.0|^8.1|^8.2|^8.3CI passing

Since Mar 6Pushed 5mo ago2 watchersCompare

[ Source](https://github.com/3sidedcube/laravel-redoc)[ Packagist](https://packagist.org/packages/3sidedcube/laravel-redoc)[ Docs](https://github.com/3sidedcube/laravel-redoc)[ RSS](/packages/3sidedcube-laravel-redoc/feed)WikiDiscussions 1.x Synced yesterday

READMEChangelog (2)Dependencies (4)Versions (5)Used By (0)

 [ ![3 Sided Cube](https://camo.githubusercontent.com/41081d63334f28da6fa6bdb4da105c3020ec777ad5341795c9e666363c0240ae/68747470733a2f2f337369646564637562652e636f6d2f6170702f7468656d65732f7473632d323031382f696d672f666f6f7465722f6c6f676f2d626c61636b2e706e67) ](https://3sidedcube.com)

Laravel Redoc
=============

[](#laravel-redoc)

[![Latest Version on Packagist](https://camo.githubusercontent.com/1d6b9e4f61790a4a059555097cb53c39129c238ee24d75e15fdb6ba7fe9a2f6a/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f337369646564637562652f6c61726176656c2d7265646f632e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/3sidedcube/laravel-redoc)[![Total Downloads](https://camo.githubusercontent.com/7b0273b12cc82182d38466d124fedd33141f3c472e4487a8bb3fb4b3153fc537/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f337369646564637562652f6c61726176656c2d7265646f632e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/3sidedcube/laravel-redoc)[![GitHub Actions](https://github.com/3sidedcube/laravel-redoc/actions/workflows/run-tests.yml/badge.svg)](https://github.com/3sidedcube/laravel-redoc/actions/workflows/run-tests.yml/badge.svg)

This package provides an easy way for rendering API documentation using OpenAPI and Redoc.

Requirements
------------

[](#requirements)

- PHP 7.4 or higher
- Laravel 8.0 or higher

Composer will automatically ensure compatible versions:

- **PHP 7.4**: Works with Laravel 8
- **PHP 8.0**: Works with Laravel 8-9
- **PHP 8.1**: Works with Laravel 8-10
- **PHP 8.2+**: Works with Laravel 8-13

Installation
------------

[](#installation)

You can install the package via composer:

```
composer require 3sidedcube/laravel-redoc
```

Usage
-----

[](#usage)

### Viewing the documentation

[](#viewing-the-documentation)

By default, the documentation is served at `/docs/api` and will load the `openapi.json` file from the `openapi` folder at the root of the project.

You can change the path used to serve the documentation by setting the `redoc.path` config option.

If you would like to change the directory where your `openapi.json` file is located, you can update `redoc.directory`config option.

### Documentation versions

[](#documentation-versions)

Laravel Redoc supports rendering multiple versions of documentation. If you would like to serve a different version of the documentation, you can include `{version}` in the `redoc.path` config option e.g. `docs/{version}/api`. This will then load the `{version}.json` file from the configured directory.

### Variables

[](#variables)

If you would like to replace a "variable" in the documentation, you can use the `redoc.variables` config option.

For example, if you would like to dynamically set the server url to the given environment, you could configure the following variable:

```
'variables' => [
    'server_url' => env('APP_URL'),
],
```

Now, when you use `:server_url` in the OpenAPI definition, it will be replaced with the value of the `APP_URL`.

Testing
-------

[](#testing)

```
composer test
```

Changelog
---------

[](#changelog)

Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.

Contributing
------------

[](#contributing)

Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

Credits
-------

[](#credits)

- [Ben Sherred](https://github.com/benshered)
- [All Contributors](../../contributors)

License
-------

[](#license)

Laravel Redoc is open-sourced software licensed under the [MIT license](LICENSE.md).

###  Health Score

45

—

FairBetter than 91% of packages

Maintenance49

Moderate activity, may be stable

Popularity34

Limited adoption so far

Community13

Small or concentrated contributor base

Maturity67

Established project with proven stability

 Bus Factor1

Top contributor holds 69.2% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~709 days

Total

3

Last Release

162d ago

PHP version history (3 changes)v1.0.0PHP ^7.4|^8.0

v1.0.1PHP ^7.4|^8.0|^8.1|^8.2|^8.3

1.x-devPHP ^7.4|^8.0|^8.1|^8.2|^8.3|^8.4

### Community

Maintainers

![](https://www.gravatar.com/avatar/436e1b99d9a5042fabdc786d56512c70af14ccb5d7f6122c340d33b9f9dd4b94?d=identicon)[3sidedcube](/maintainers/3sidedcube)

---

Top Contributors

[![bensherred](https://avatars.githubusercontent.com/u/22666637?v=4)](https://github.com/bensherred "bensherred (9 commits)")[![desmond3sidedcube](https://avatars.githubusercontent.com/u/224592872?v=4)](https://github.com/desmond3sidedcube "desmond3sidedcube (3 commits)")[![AndrewHaswell](https://avatars.githubusercontent.com/u/4202357?v=4)](https://github.com/AndrewHaswell "AndrewHaswell (1 commits)")

---

Tags

3sidedcubelaravel-redoc

###  Code Quality

Code StylePHP CS Fixer

### Embed Badge

![Health badge](/badges/3sidedcube-laravel-redoc/health.svg)

```
[![Health](https://phpackages.com/badges/3sidedcube-laravel-redoc/health.svg)](https://phpackages.com/packages/3sidedcube-laravel-redoc)
```

###  Alternatives

[psalm/plugin-laravel

Psalm plugin for Laravel

3355.3M345](/packages/psalm-plugin-laravel)[laravel/mcp

Rapidly build MCP servers for your Laravel applications.

77022.3M151](/packages/laravel-mcp)[api-platform/laravel

API Platform support for Laravel

58171.5k14](/packages/api-platform-laravel)[hasinhayder/tyro-dashboard

Tyro Dashboard - Beautiful admin dashboard for managing Tyro roles, privileges, users, and settings

5443.8k](/packages/hasinhayder-tyro-dashboard)[laravel/surveyor

Static analysis tool for Laravel applications.

86121.4k11](/packages/laravel-surveyor)[fleetbase/core-api

Core Framework and Resources for Fleetbase API

1235.9k20](/packages/fleetbase-core-api)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)