PHPackages                             bchalier/laravel-openapi-autodoc - 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. bchalier/laravel-openapi-autodoc

ActiveLibrary[API Development](/categories/api)

bchalier/laravel-openapi-autodoc
================================

Automatic documentation of laravel in OpenApi format.

0.3.0(3mo ago)215.5k↑150%1MITPHPPHP ^8.1|^8.2|^8.3|^8.4CI failing

Since Aug 10Pushed 3mo ago2 watchersCompare

[ Source](https://github.com/bchalier/laravel-openapi-autodoc)[ Packagist](https://packagist.org/packages/bchalier/laravel-openapi-autodoc)[ RSS](/packages/bchalier-laravel-openapi-autodoc/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (10)Dependencies (6)Versions (19)Used By (0)

Laravel OpenAPI Autodoc
=======================

[](#laravel-openapi-autodoc)

Generates OpenAPI v3 documentation from your Laravel routes, FormRequests and API Resources.

Compatible with Laravel 10–12 and PHP 8.1–8.4.

Install
-------

[](#install)

1. Require the package in your app (Composer path repo supported):
2. Publish the config if you need to customize:

`php artisan vendor:publish --tag=config --provider="Bchalier\LaravelOpenapiDoc\App\Providers\LoadingServiceProvider"`

Usage
-----

[](#usage)

- Generate the JSON file:
    - `php artisan documentation:generate`
- Output file:
    - Stored on the `public` disk at `storage/app/public/documentation/openapi.json`.
    - If you’ve run `php artisan storage:link`, it’s available at `/storage/documentation/openapi.json`.

How it works
------------

[](#how-it-works)

- Parses route list and filters via `config/documentation.php`.
- Infers request schemas from FormRequest validation rules.
- Infers response schemas from return types: `JsonResource`, `ResourceCollection`, `JsonResponse`.
- Uses docblocks for operation summary/description and `@throws` to add error responses.

Notes
-----

[](#notes)

- Models instantiated for resources must use `Illuminate\Database\Eloquent\Factories\HasFactory`.
- When route names are missing, operationId falls back to `_`.

###  Health Score

53

—

FairBetter than 97% of packages

Maintenance79

Regular maintenance activity

Popularity29

Limited adoption so far

Community11

Small or concentrated contributor base

Maturity75

Established project with proven stability

 Bus Factor1

Top contributor holds 96% 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 ~139 days

Recently: every ~348 days

Total

18

Last Release

112d ago

PHP version history (4 changes)0.0.1PHP ^7.2

0.0.3PHP ^7.4

0.0.5PHP ^7.4|^8.0

0.2.0PHP ^8.1|^8.2|^8.3|^8.4

### Community

Maintainers

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

---

Top Contributors

[![bchalier](https://avatars.githubusercontent.com/u/17746418?v=4)](https://github.com/bchalier "bchalier (48 commits)")[![Oipnet](https://avatars.githubusercontent.com/u/13480665?v=4)](https://github.com/Oipnet "Oipnet (2 commits)")

---

Tags

laravelautomationdocumentationopenapigeneratordocopen-api

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/bchalier-laravel-openapi-autodoc/health.svg)

```
[![Health](https://phpackages.com/badges/bchalier-laravel-openapi-autodoc/health.svg)](https://phpackages.com/packages/bchalier-laravel-openapi-autodoc)
```

###  Alternatives

[darkaonline/l5-swagger

OpenApi or Swagger integration to Laravel

2.9k34.0M112](/packages/darkaonline-l5-swagger)[darkaonline/swagger-lume

OpenApi or Swagger integration to Lumen

3372.3M3](/packages/darkaonline-swagger-lume)[swisnl/openapi-spec-generator

Creates Open API spec for a Laravel JSON:API

2338.1k](/packages/swisnl-openapi-spec-generator)

PHPackages © 2026

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