PHPackages                             neondigital/openapi-spec-generator - 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. neondigital/openapi-spec-generator

ActiveLibrary

neondigital/openapi-spec-generator
==================================

Creates Open API spec for a Laravel JSON:API

675420[1 issues](https://github.com/neondigital/openapi-spec-generator/issues)PHP

Since Apr 29Pushed 5y ago2 watchersCompare

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

READMEChangelogDependenciesVersions (1)Used By (0)

OpenAPI v3 Spec Generator
=========================

[](#openapi-v3-spec-generator)

Designed to work with [Laravel JSON:API](https://laraveljsonapi.io/)

!!! Disclaimer: this project is work in progress and likely contains many bugs, etc !!!

TODO
----

[](#todo)

- Command to generate to storage folder
- Get basic test suite running with GitHub Actions
- Add extra operation descriptons via config
- Add in tags & x-tagGroups (via config)
- Consider `->readonly()` etc in routes
- Remove links in payload data when saving resources
- Fix includes and relations
- Tidy up the code!!
- Add tests

🙏 Based upon initial prototype by [martianatwork](https://github.com/martianatwork)

Usage
-----

[](#usage)

Install package

```
composer install neondigital/openapi-spec-generator

```

Publish the config file

```
php artisan vendor:publish --provider="LaravelJsonApi\OpenApiSpec\OpenApiServiceProvider"

```

Generate the Open API spec

```
php artisan jsonapi:openapi:generate v1

```

Generating Documentation
------------------------

[](#generating-documentation)

A quick way to preview your documentation is to use [Speccy](https://speccy.io/). Ensure you have installed Speccy globally and then you can use the following command.

```
speccy serve storage/app/v1_openapi.yaml

```

###  Health Score

21

—

LowBetter than 19% of packages

Maintenance17

Infrequent updates — may be unmaintained

Popularity23

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity29

Early-stage or recently created project

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.

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/6089840?v=4)[Neon Digital](/maintainers/neondigital)[@neondigital](https://github.com/neondigital)

### Embed Badge

![Health badge](/badges/neondigital-openapi-spec-generator/health.svg)

```
[![Health](https://phpackages.com/badges/neondigital-openapi-spec-generator/health.svg)](https://phpackages.com/packages/neondigital-openapi-spec-generator)
```

PHPackages © 2026

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