PHPackages                             aseeb/laravel-api-changelog-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. [API Development](/categories/api)
4. /
5. aseeb/laravel-api-changelog-generator

ActiveLibrary[API Development](/categories/api)

aseeb/laravel-api-changelog-generator
=====================================

Automatically generates a changelog for Laravel API changes by monitoring routes, models, and resources.

v1.0.0(9mo ago)12MITPHPPHP ^8.1

Since Sep 11Pushed 9mo agoCompare

[ Source](https://github.com/asxxb/laravel-api-changelog-generator)[ Packagist](https://packagist.org/packages/aseeb/laravel-api-changelog-generator)[ RSS](/packages/aseeb-laravel-api-changelog-generator/feed)WikiDiscussions main Synced today

READMEChangelogDependencies (5)Versions (2)Used By (0)

🌟 Laravel API Changelog Generator
=================================

[](#-laravel-api-changelog-generator)

[![License: MIT](https://camo.githubusercontent.com/fdf2982b9f5d7489dcf44570e714e3a15fce6253e0cc6b5aa61a075aac2ff71b/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4c6963656e73652d4d49542d79656c6c6f772e737667)](https://opensource.org/licenses/MIT)[![PHP Version](https://camo.githubusercontent.com/be8868e9d5f6ba5a5e06b2c165afa615bee6c223aea3594abb699e7c1a731dec/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5048502d253345253344382e312d627269676874677265656e2e737667)](https://www.php.net/)[![Laravel Version](https://camo.githubusercontent.com/650657b40c151090639edd1e978b6ba7149e1be4f765a62e2b0c1b20c4ba602d/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4c61726176656c2d392532422532433130253243313125324331322d626c75652e737667)](https://laravel.com/)

Automatically generates a **changelog for Laravel API changes** by monitoring:

- API routes
- Eloquent models
- API resources

Keeps **backend and frontend teams** in sync and ensures smooth collaboration.

> ⚡ **No security concerns:** This package only reads your codebase and generates changelog files. It does **not** send data externally or modify your application.

---

🌐 Features
----------

[](#-features)

- Detect **added, removed, or modified API routes**.
- Track **fillable and casts changes in models**.
- Track **changes in API resources** (method signatures).
- Generate a **Markdown changelog** (`API_CHANGELOG.md`).
- Incrementally compare snapshots for **accurate change detection**.
- Fully compatible with **Laravel 9, 10, 11, and 12**.

---

⚙️ Installation
---------------

[](#️-installation)

### **Via Composer**

[](#via-composer)

```
composer require aseeb/laravel-api-changelog-generator:@dev
```

> After a stable release (tagged version), you can install without `@dev`:
>
> ```
> composer require aseeb/laravel-api-changelog-generator:^1.0
> ```

---

### **Publish Configuration (Optional)**

[](#publish-configuration-optional)

```
php artisan vendor:publish --provider="Aseeb\ApiChangelogGenerator\ApiChangelogGeneratorServiceProvider" --tag=config
```

- This creates `config/api-changelog.php` in your Laravel project.
- Customize paths, snapshot storage, or changelog file location.

---

- **paths.models** → Eloquent models directory.
- **paths.resources** → API resources directory.
- **api\_route\_prefix** → Only scan routes starting with this prefix.
- **snapshot\_file** → Internal JSON snapshot.
- **changelog\_file** → Markdown changelog file.

---

🚀 Usage
-------

[](#-usage)

### **Generate API Changelog**

[](#generate-api-changelog)

```
php artisan api:changelog
```

- **First run:** creates an initial snapshot.
- **Subsequent runs:** compares changes and appends them to `API_CHANGELOG.md`.

### **Example Output**

[](#example-output)

```
# API Changelog

## [September 11, 2025]

### Routes Changes
#### Added
- `GET /api/users`
#### Removed
- `POST /api/old-endpoint`
#### Modified
- `PUT /api/profile` was modified.

### Models Changes
#### Added
- `App\Models\User`
#### Modified
- `App\Models\Post` was modified.

### Resources Changes
#### Modified
- `App\Http\Resources\UserResource` was modified.
```

---

🎨 Benefits
----------

[](#-benefits)

- **Automates documentation** of API changes.
- Keeps frontend developers up-to-date with backend changes.
- **Avoids manual tracking** of routes, models, and resources.
- Safe for production use — **no external calls or data modifications**.

---

🛡 Security
----------

[](#-security)

- **No data leaves your system**.
- Only reads local files and writes a changelog.
- No sensitive information is exposed.
- Fully safe for **production environments**.

---

💡 Contributing
--------------

[](#-contributing)

1. Fork the repository
2. Create a feature branch (`git checkout -b feature/my-feature`)
3. Commit your changes (`git commit -m 'Add new feature'`)
4. Push to the branch (`git push origin feature/my-feature`)
5. Open a Pull Request

---

📝 License
---------

[](#-license)

MIT License — see [LICENSE](LICENSE).

---

📧 Author
--------

[](#-author)

**Aseeb Shibin**

- Email:
- GitHub: https://github.com/aseeb

###  Health Score

30

—

LowBetter than 62% of packages

Maintenance56

Moderate activity, may be stable

Popularity4

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity45

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% 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

Unknown

Total

1

Last Release

296d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/55710160?v=4)[aseeb shibin](/maintainers/asxxb)[@asxxb](https://github.com/asxxb)

---

Top Contributors

[![asxxb](https://avatars.githubusercontent.com/u/55710160?v=4)](https://github.com/asxxb "asxxb (8 commits)")

### Embed Badge

![Health badge](/badges/aseeb-laravel-api-changelog-generator/health.svg)

```
[![Health](https://phpackages.com/badges/aseeb-laravel-api-changelog-generator/health.svg)](https://phpackages.com/packages/aseeb-laravel-api-changelog-generator)
```

###  Alternatives

[laravel/ai

The official AI SDK for Laravel.

1.0k3.2M193](/packages/laravel-ai)[illuminate/queue

The Illuminate Queue package.

21332.6M1.6k](/packages/illuminate-queue)[illuminate/session

The Illuminate Session package.

9939.3M850](/packages/illuminate-session)[moonshine/moonshine

Laravel administration panel

1.3k253.1k81](/packages/moonshine-moonshine)[tallstackui/tallstackui

TallStackUI is a powerful suite of Blade components that elevate your workflow of Livewire applications.

725173.0k14](/packages/tallstackui-tallstackui)[roots/acorn

Framework for Roots WordPress projects built with Laravel components.

9762.4M131](/packages/roots-acorn)

PHPackages © 2026

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