PHPackages                             juststeveking/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. juststeveking/laravel-redoc

ActiveLibrary[API Development](/categories/api)

juststeveking/laravel-redoc
===========================

A simple API documentation package for Laravel using OpenAPI and Redoc

2.1.0(2y ago)92312.7k↓67.1%11[3 issues](https://github.com/JustSteveKing/laravel-redoc/issues)1MITPHPPHP ^8.0

Since May 6Pushed 2y ago1 watchersCompare

[ Source](https://github.com/JustSteveKing/laravel-redoc)[ Packagist](https://packagist.org/packages/juststeveking/laravel-redoc)[ GitHub Sponsors](https://github.com/JustSteveKing)[ RSS](/packages/juststeveking-laravel-redoc/feed)WikiDiscussions main Synced 3d ago

READMEChangelog (6)Dependencies (3)Versions (7)Used By (1)

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

[](#laravel-redoc)

[![Latest Version on Packagist](https://camo.githubusercontent.com/0e8509d9b6e6ec9f17ff281040124db742040a3f29dcc7a8e9ace7a84e8784b4/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6a75737473746576656b696e672f6c61726176656c2d7265646f632e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/juststeveking/laravel-redoc)[![Software License](https://camo.githubusercontent.com/55c0218c8f8009f06ad4ddae837ddd05301481fcf0dff8e0ed9dadda8780713e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d627269676874677265656e2e7376673f7374796c653d666c61742d737175617265)](LICENSE.md)[![Build Status](https://github.com/JustSteveKing/laravel-redoc/workflows/run-tests/badge.svg?branch=main)](https://github.com/JustSteveKing/laravel-redoc/actions)[![Total Downloads](https://camo.githubusercontent.com/0df48209aa8a44b0948bc1d6fd6187a21943d795b8167857c64e16e7ded39b1d/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f6a75737473746576656b696e672f6c61726176656c2d7265646f632e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/juststeveking/laravel-redoc)

Easily publish your API documentation using your OpenAPI document in your Laravel Application.

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

[](#installation)

You can install this package via composer:

```
composer require juststeveking/laravel-redoc
```

Enabling Alfred
---------------

[](#enabling-alfred)

To enable Alfred on your docs, visit:  or

Configuration
-------------

[](#configuration)

You can publish the configuration file with:

```
php artisan vendor:publish --provider="JustSteveKing\Laravel\LaravelRedoc\RedocServiceProvider" --tag="config"
```

This is the contents of the published config file:

```
return [
    'path' => [
        'name' => env('REDOC_PATH_NAME', 'docs'),
        'url' => env('REDOC_PATH_URL', 'api/docs'),
    ],

    'alfred' => [
        'enabled' => env('REDOC_ALFRED', true),
        'project_id' => env('ALFRED_PROJECT_ID', null),
        'api_key' => env('ALFRED_API_KEY', null),
    ],

    'openapi' => [
        'path' => env('REDOC_OPENAPI_PATH', 'http://petstore.swagger.io/v2/swagger.json')
    ],

    'config' => [
        'search' => false,

        'hostname' => false,

        'loading' => false,

        'menu' => true,

        'scrollbars' => true,

        'trust' => true,
    ]
];
```

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

[](#contributing)

Please see [CONTRIBUTING](CONTRIBUTING.md) and [CODE\_OF\_CONDUCT](CODE_OF_CONDUCT.md) for details.

Security
--------

[](#security)

If you discover any security related issues, please email  instead of using the issue tracker.

Credits
-------

[](#credits)

- [Steve McDougall](https://github.com/JustSteveKing)
- [All Contributors](../../contributors)
- [Redocly Team for their open source tool redoc](https://github.com/Redocly/redoc)

License
-------

[](#license)

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

###  Health Score

41

—

FairBetter than 87% of packages

Maintenance19

Infrequent updates — may be unmaintained

Popularity50

Moderate usage in the ecosystem

Community17

Small or concentrated contributor base

Maturity62

Established project with proven stability

 Bus Factor1

Top contributor holds 91.3% 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 ~226 days

Recently: every ~283 days

Total

6

Last Release

753d ago

Major Versions

0.0.2 → 1.0.02022-02-22

1.0.0 → 2.0.02023-02-27

### Community

Maintainers

![](https://www.gravatar.com/avatar/a87fe82b349821ebd49cf57d65c4cd3e33ae0833222a8438d90fe8921ca899ea?d=identicon)[JustSteveKing](/maintainers/JustSteveKing)

---

Top Contributors

[![JustSteveKing](https://avatars.githubusercontent.com/u/6368379?v=4)](https://github.com/JustSteveKing "JustSteveKing (21 commits)")[![ddouble-d](https://avatars.githubusercontent.com/u/57027918?v=4)](https://github.com/ddouble-d "ddouble-d (1 commits)")[![mikebronner](https://avatars.githubusercontent.com/u/1791050?v=4)](https://github.com/mikebronner "mikebronner (1 commits)")

---

Tags

apilaraveldocumentationopenapiredoc

###  Code Quality

TestsPHPUnit

### Embed Badge

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

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

###  Alternatives

[darkaonline/l5-swagger

OpenApi or Swagger integration to Laravel

3.0k37.6M134](/packages/darkaonline-l5-swagger)[binarytorch/larecipe

Generate gorgeous recipes for your Laravel applications using MarkDown

2.5k2.9M17](/packages/binarytorch-larecipe)[api-platform/laravel

API Platform support for Laravel

58171.5k14](/packages/api-platform-laravel)[juststeveking/laravel-stoplight-elements

A simple API documentation package for Laravel using OpenAPI and Stoplight Elements

4481.7k](/packages/juststeveking-laravel-stoplight-elements)

PHPackages © 2026

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