PHPackages                             solomon04/documentation - 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. solomon04/documentation

Abandoned → [icodestuff/ladocumenter](/?search=icodestuff%2Fladocumenter)Library[API Development](/categories/api)

solomon04/documentation
=======================

Generate API Documentation for your Laravel applications using annotations & LaRecipe.

0.3(5y ago)3463MITPHPPHP ^7.3CI failing

Since May 30Pushed 5y ago1 watchersCompare

[ Source](https://github.com/Solomon04/documenter)[ Packagist](https://packagist.org/packages/solomon04/documentation)[ RSS](/packages/solomon04-documentation/feed)WikiDiscussions master Synced 1w ago

READMEChangelog (3)Dependencies (5)Versions (4)Used By (0)

 Laravel REST API Documenter
 [![example](/example.png)](/example.png)
=======================================================================

[](#----laravel-rest-api-documenter--------)

 [![CircleCI](https://camo.githubusercontent.com/7715fb5cf4848781a5c2ee39960b3ff9e7616e1ed3cc9f68237e08b4161c339e/68747470733a2f2f636972636c6563692e636f6d2f67682f536f6c6f6d6f6e30342f646f63756d656e7465722e737667)](https://camo.githubusercontent.com/7715fb5cf4848781a5c2ee39960b3ff9e7616e1ed3cc9f68237e08b4161c339e/68747470733a2f2f636972636c6563692e636f6d2f67682f536f6c6f6d6f6e30342f646f63756d656e7465722e737667) [![Total Downloads](https://camo.githubusercontent.com/4d63b342959f3a81b3e51e863957584557ba480e912e123fbac1b2d54edd19fb/68747470733a2f2f706f7365722e707567782e6f72672f736f6c6f6d6f6e30342f646f63756d656e746174696f6e2f642f746f74616c2e737667)](https://packagist.org/packages/solomon04/documentation) [![Latest Stable Version](https://camo.githubusercontent.com/b783001575ebe58f1cd592dba2e7f47bcd0f674b2315d7c03f5a974636c15dbf/68747470733a2f2f706f7365722e707567782e6f72672f736f6c6f6d6f6e30342f646f63756d656e746174696f6e2f762f737461626c652e737667)](https://packagist.org/packages/solomon04/documentation) [![License](https://camo.githubusercontent.com/76eb3d507593aacad660f2d94a0e6e3cd77de5a572a685dbfb3ce04f6bbb94d0/68747470733a2f2f706f7365722e707567782e6f72672f736f6c6f6d6f6e30342f646f63756d656e746174696f6e2f6c6963656e73652e737667)](https://packagist.org/packages/solomon04/documentation)

### Generate Documentation for your REST API

[](#generate-documentation-for-your-rest-api)

This package allows you to generate documentation for your REST API via annotations. The markdown is then served by [LaRecipe](https://larecipe.binarytorch.com.my/) to generate beautiful documentation for your API.

**Note this package is NOT stable. I've used it for only one of my repo's.**

### Getting Started

[](#getting-started)

#### Install [LaRecipe](https://larecipe.binarytorch.com.my/)

[](#install-larecipe)

It is mandatory you install the LaRecipe package in order to get the benefits of the API documenter.

Install LaRecipe via composer.

`composer require binarytorch/larecipe`

Run the install command.

`php artisan larecipe:install`

#### Install Documenter

[](#install-documenter)

Install Documenter via composer

`composer require solomon04/documentation`

Publish provider

`php artisan vendor:publish --provider="Solomon04\Documentation\DocumentationServiceProvider"`

### Steps

[](#steps)

1. Go to an API controller
2. Add [available annotations](#available-annotations) to the file.
3. Run `php artisan docs:generate`

#### Available Annotations:

[](#available-annotations)

##### @Group

[](#group)

The group annotation is used to group endpoints within a single controller class.

##### Attributes

[](#attributes)

- Name (required)
- Description (optional)

##### Example

[](#example)

```
/**
 * @Group(name="Foo", description="This is an example group.")
 */
class FooController extends Controller
{

}
```

##### @Meta

[](#meta)

The meta annotation is used to document a single endpoint. This would be a function within a controller class.

##### Attributes

[](#attributes-1)

- Name (required)
- Href (required)
- Description (optional)

##### Example

[](#example-1)

```
class FooController extends Controller
{
    /**
    * @Meta(name="Example", description="This is an example endpoint.", href="example")
     */
    public function bar()
    {

    }
}
```

##### @BodyParam

[](#bodyparam)

The body param annotation is used to document the available body parameters within a single endpoint request.

##### Attributes

[](#attributes-2)

- Name (required)
- Type (required)
- Status (required)
- Description (optional)
- Example (optional)

##### Example

[](#example-2)

```
class FooController extends Controller
{
    /**
    * @BodyParam(name="foo", type="string", status="required", description="An example body paramater", example="bar")
     */
    public function bar(FormRequest $request)
    {

    }
}
```

##### @QueryParam

[](#queryparam)

The query param annotation is used to document the available query parameters within a single endpoint request.

##### Attributes

[](#attributes-3)

- Name (required)
- Type (required)
- Status (required)
- Description (optional)
- Example (optional)

##### Example

[](#example-3)

```
class FooController extends Controller
{
    /**
    * @QueryParam(name="foo", type="string", status="optional", description="An example query paramater", example="bar")
     */
    public function bar()
    {

    }
}
```

##### @ResponseExample

[](#responseexample)

The response example annotation is used to give an example response for an endpoint.

**Important Note:** Response example file must be stored in the `storage/` directory.

##### Attributes

[](#attributes-4)

- Status (required)
- Example (required)

##### Example

[](#example-4)

```
class FooController extends Controller
{
    /**
    * @ResponseExample(status=200, example="responses/example.json")
     */
    public function bar()
    {
        return response()->json(['foo' => 'bar']);
    }
}
```

### Demo Laravel App

[](#demo-laravel-app)

View an [example](https://github.com/Solomon04/documenter-example) of documentation using the Laravel REST API Documenter.

### Tutorial

[](#tutorial)

View a video tutorial [here](https://youtube.com)

###  Health Score

24

—

LowBetter than 32% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity16

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity43

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

Total

3

Last Release

2163d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/180fec65ce73b52ee74a22c013fa889cc316bae04d1477a7423e6f71918d67c0?d=identicon)[solomon\_04](/maintainers/solomon_04)

---

Top Contributors

[![Solomon04](https://avatars.githubusercontent.com/u/35110194?v=4)](https://github.com/Solomon04 "Solomon04 (28 commits)")

---

Tags

documentationswaggeropenapiapidoclarecipelaravel-apiapi-documentationdocumenter

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/solomon04-documentation/health.svg)

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

###  Alternatives

[swagger-api/swagger-ui

 Swagger UI is a collection of HTML, Javascript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.

28.7k45.4M99](/packages/swagger-api-swagger-ui)[darkaonline/l5-swagger

OpenApi or Swagger integration to Laravel

2.9k34.0M112](/packages/darkaonline-l5-swagger)[darkaonline/swagger-lume

OpenApi or Swagger integration to Lumen

3372.3M3](/packages/darkaonline-swagger-lume)[johnylemon/laravel-apidocs

Laravel API documentation generating tool

472.8k](/packages/johnylemon-laravel-apidocs)[adrenalinkin/swagger-resolver-bundle

Provides possibility for validate data according to Swagger documentation

1013.3k](/packages/adrenalinkin-swagger-resolver-bundle)

PHPackages © 2026

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