PHPackages                             f2m2/apidocs - 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. f2m2/apidocs

ActiveLibrary[API Development](/categories/api)

f2m2/apidocs
============

Laravel API Documentation Generator

2.0.2(7y ago)9136.5k29[3 issues](https://github.com/f2m2/apidocs/issues)MITPHPPHP >=5.4.0

Since Nov 25Pushed 7y ago3 watchersCompare

[ Source](https://github.com/f2m2/apidocs)[ Packagist](https://packagist.org/packages/f2m2/apidocs)[ Docs](https://github.com/f2m2/apidocs)[ RSS](/packages/f2m2-apidocs/feed)WikiDiscussions master Synced today

READMEChangelog (1)Dependencies (2)Versions (6)Used By (0)

Laravel API Docs Generator
==========================

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

This Laravel package provides an API Documentation generator based upon your Routes and Controller Method DocBlock comments.

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

[](#installation)

#### Laravel 5.0

[](#laravel-50)

Begin by installing this package through Composer. Edit your project's `composer.json` file to require `f2m2/apidocs`.

```
"require-dev": {
    "f2m2/apidocs": "dev-master"
}

```

Next, update Composer from the Terminal:

```
composer update

```

Once the packaage has installed, the final step is to add the service provider. Open `config/app.php`, and add a new item to the providers array.

```
'F2m2\Apidocs\ApidocsServiceProvider',

```

Run the `artisan` command from the Terminal to see the new `apidocs` command.

```
php artisan apidocs:generate

```

Create a copy of the API Docs Config by running this `artisan` command:

```
php artisan vendor:publish

```

#### Laravel 4.2

[](#laravel-42)

See installation:

Notes
-----

[](#notes)

##### Route Prefix

[](#route-prefix)

Create a prefix for your routes with an API Version. i.e. 'api/v1

```
Route::group(['prefix' => 'api/v1'], function(){
     // ...
});

```

\######## Laravel 5.4 defaults to api prefix (`Route::prefix('api')`). If your routes/api.php looks like this...

```
Route::group(['prefix' => 'v1'], function(){
     // ...
});

```

... then the route for the generate command would be `api/v1`Otherwise it will be just `api`

##### DocBlock Example

[](#docblock-example)

Below is a docBlock example.

```
/**
* Display the specified resource.
* GET /user/{id}
*
* @param  int  $id  The id of a User
* @return Response
*/
public function show($id)
{
    // Display User
}

```

License
-------

[](#license)

See [LICENSE](LICENSE.md) file.

###  Health Score

38

—

LowBetter than 83% of packages

Maintenance19

Infrequent updates — may be unmaintained

Popularity40

Moderate usage in the ecosystem

Community19

Small or concentrated contributor base

Maturity62

Established project with proven stability

 Bus Factor1

Top contributor holds 92.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 ~532 days

Total

4

Last Release

2641d ago

Major Versions

1.0 → 2.02015-07-25

PHP version history (2 changes)1.0PHP >=5.4.0

2.0PHP >=5.3.0

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/241139?v=4)[F2M2, Inc.](/maintainers/f2m2)[@f2m2](https://github.com/f2m2)

---

Top Contributors

[![f2m2rd](https://avatars.githubusercontent.com/u/1012932?v=4)](https://github.com/f2m2rd "f2m2rd (59 commits)")[![eddturtle](https://avatars.githubusercontent.com/u/902607?v=4)](https://github.com/eddturtle "eddturtle (2 commits)")[![Artistan](https://avatars.githubusercontent.com/u/801349?v=4)](https://github.com/Artistan "Artistan (1 commits)")[![nickescobedo](https://avatars.githubusercontent.com/u/2837169?v=4)](https://github.com/nickescobedo "nickescobedo (1 commits)")[![stesvis](https://avatars.githubusercontent.com/u/6062684?v=4)](https://github.com/stesvis "stesvis (1 commits)")

### Embed Badge

![Health badge](/badges/f2m2-apidocs/health.svg)

```
[![Health](https://phpackages.com/badges/f2m2-apidocs/health.svg)](https://phpackages.com/packages/f2m2-apidocs)
```

###  Alternatives

[craftcms/cms

Craft CMS

3.6k3.6M3.1k](/packages/craftcms-cms)[defstudio/telegraph

A laravel facade to interact with Telegram Bots

816333.6k3](/packages/defstudio-telegraph)[simplestats-io/laravel-client

Server-side analytics for Laravel that follows the full funnel from visit to registration to payment, attributed to the channel that drove it. Revenue, MRR, churn and ad-spend profit (ROAS/CAC) per channel. GDPR compliant, ad-blocker proof.

5021.9k](/packages/simplestats-io-laravel-client)

PHPackages © 2026

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