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

ActiveLibrary[API Development](/categories/api)

codev/apidocs
=============

Laravel API Documentation Generator

2.0.3(4y ago)118MITPHPPHP ^7.3

Since May 11Pushed 4y ago1 watchersCompare

[ Source](https://github.com/codev-vn/apidocs)[ Packagist](https://packagist.org/packages/codev/apidocs)[ Docs](https://github.com/codev-vn/apidocs)[ RSS](/packages/codev-apidocs/feed)WikiDiscussions master Synced 1w ago

READMEChangelog (10)Dependencies (2)Versions (12)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. Packagist:

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

[](#installation)

#### Laravel 5.0 -> 8.0

[](#laravel-50---80)

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

```
composer require --dev codev/apidocs

```

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.

```
'Codev\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

```

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)

This package we are developing from . We ask for permission from F2M2 to use the source code to further develop the project and serve the community. Thanks F2M2.

Codev Service Co.,Ltd at

See [LICENSE](LICENSE.md) file.

###  Health Score

24

—

LowBetter than 32% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity8

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity53

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

Every ~1 days

Total

11

Last Release

1822d ago

Major Versions

1.0.7 → 2.0.12021-05-22

### Community

Maintainers

![](https://www.gravatar.com/avatar/3581ae9f2291c78a1720f73d993b6bf0ce9323775aba4b7c593e8cabbfab1b76?d=identicon)[nhiepphong](/maintainers/nhiepphong)

---

Top Contributors

[![nhiepphong](https://avatars.githubusercontent.com/u/2688282?v=4)](https://github.com/nhiepphong "nhiepphong (13 commits)")

###  Code Quality

TestsPHPUnit

### Embed Badge

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

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

###  Alternatives

[mollie/laravel-mollie

Mollie API client wrapper for Laravel & Mollie Connect provider for Laravel Socialite

3624.1M28](/packages/mollie-laravel-mollie)[mll-lab/laravel-graphiql

Easily integrate GraphiQL into your Laravel project

683.2M9](/packages/mll-lab-laravel-graphiql)[spatie/laravel-route-discovery

Auto register routes using PHP attributes

23645.0k2](/packages/spatie-laravel-route-discovery)[esign/laravel-conversions-api

A laravel wrapper package around the Facebook Conversions API

69145.4k](/packages/esign-laravel-conversions-api)[didww/didww-api-3-php-sdk

PHP SDK for DIDWW API 3

1218.2k](/packages/didww-didww-api-3-php-sdk)[surface/laravel-webfinger

A Laravel package to create an ActivityPub webfinger.

113.8k](/packages/surface-laravel-webfinger)

PHPackages © 2026

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