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

ActiveLibrary[API Development](/categories/api)

paplauskas/apidocs
==================

A simple plug-and-play Laravel 5 package that will automatically generate API documentation from your routes file.

0.2(9y ago)21.0k2MITPHPPHP >=5.5.9

Since Mar 31Pushed 9y ago1 watchersCompare

[ Source](https://github.com/TadasPaplauskas/apidocs)[ Packagist](https://packagist.org/packages/paplauskas/apidocs)[ Docs](https://github.com/TadasPaplauskas/apidocs)[ RSS](/packages/paplauskas-apidocs/feed)WikiDiscussions master Synced 2mo ago

READMEChangelogDependencies (1)Versions (8)Used By (0)

ApiDocs
=======

[](#apidocs)

### What is this repository for?

[](#what-is-this-repository-for)

A simple plug-and-play Laravel 5 package that will generate a nice API documentation page based on your documented routes.

[![List view](https://raw.githubusercontent.com/TadasPaplauskas/apidocs/screenshots/list.PNG "List view")](https://raw.githubusercontent.com/TadasPaplauskas/apidocs/screenshots/list.PNG)

### Setup

[](#setup)

Do NOT install this package on your production environment unless you intend to make your API documentation public. In most cases it's best to keep it in the development environment.

Run this in your project folder:

```
composer require paplauskas/apidocs --dev

```

Add this to the config/app.php providers:

```
Paplauskas\ApiDocs\ApiDocsServiceProvider::class,

```

That's it!

### How do I use it?

[](#how-do-i-use-it)

If setting up ApiDocs went well, you should be able to access it through /apidocs route (for example ).

Please note that you still have to document your endpoints by hand - ain't no magic here.

### How to write documentation?

[](#how-to-write-documentation)

Just write comments right next to your routes. Api endpoint description format is pretty similar to the usual DocBlocks format. Write comments right before the route you wish to document. Example:

```
    /**
    * @title Upload an image
    * @description Uploads the original image to the server, resizes it.
    * @group Images
    * @param  image
    * @param  scale
    * @return stored image url
    */
    Route::post('images/upload', 'ImageController@upload');

    /**
    * Get image
    * Returns image info
    * @group Images
    * @param  imageID
    * @return path
    * @return alt
    * @return width
    * @return height
    */
    Route::get('images/{imageID}', 'ImageController@show');

```

As you probably noticed, @ title and @ description are optional tags - the first line is always treated as a title. @param, @return can be declared in several lines if you want to. Description line is optional and doesn't have to be specified at all. Use whatever format is more readable to you.

Package is smart enough to recognise group prefixes, so don't worry about them.

Undocumented routes are ignored.

ApiDocs checks for routes in the usual locations:

- app/Http/routes.php
- routes/api.php
- routes/web.php

### Found a bug?

[](#found-a-bug)

File an issue in issue tracker.

###  Health Score

28

—

LowBetter than 54% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity18

Limited adoption so far

Community9

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 ~45 days

Total

5

Last Release

3513d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/8c7f09b58a1f5aceceb12e372e247b668321cfb2c24170f3949ed89eff42f3c5?d=identicon)[TadasPaplauskas](/maintainers/TadasPaplauskas)

---

Top Contributors

[![tadaspaplauskas](https://avatars.githubusercontent.com/u/5982246?v=4)](https://github.com/tadaspaplauskas "tadaspaplauskas (36 commits)")

---

Tags

apilaraveldocumentationgeneratordocblock

### Embed Badge

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

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

###  Alternatives

[mpociot/laravel-apidoc-generator

Generate beautiful API documentation from your Laravel application

3.5k3.1M12](/packages/mpociot-laravel-apidoc-generator)

PHPackages © 2026

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