PHPackages                             waxwink/docgen - 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. waxwink/docgen

ActiveLibrary[API Development](/categories/api)

waxwink/docgen
==============

A laravel package for dynamic API documentation generating

146JavaScript

Since Jan 2Pushed 6y agoCompare

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

READMEChangelogDependenciesVersions (1)Used By (0)

DocGen
======

[](#docgen)

If you need a minimal API documentation quickly for your front end team, this package might help you.

Instruction
-----------

[](#instruction)

For installing just use the following command:

```
composer require waxwink/docgen

```

After that publish the necessary js ans css files to public folder for the documentation view:

```
php artisan vendor:publish --tag=public

```

This package can now work by going to `/routes` url but for more complete api documentation you need to follow some rules in your laravel app:

### Request Body

[](#request-body)

For including the request body of each route to the documentation you must use a FormRequest object as a input parameter in the related controller. DocGen will use that request object to resolve the request body and the rules will be shown exactly like what is written in the rules method of the request object.

### Output Keys

[](#output-keys)

For including the output keys of a route every route should use a JsonResource to show the output. DocGen must be aware of this resource by put it as doc block (with `@DG-Resource`) in the controller method as follows:

```
    /**
     * @DG-Resource App\Http\Resources\OrderResource
     *
     * @param OrderRequest $request
     * @return AnonymousResourceCollection
     */
    public function index(OrderRequest $request)
    {
        //....
    }
```

###  Health Score

19

—

LowBetter than 10% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity9

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity34

Early-stage or recently created project

 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.

### Community

Maintainers

![](https://www.gravatar.com/avatar/691322b900db6b86519a6d891a39ea59824fc8cb95330303933c81be13a8dbb2?d=identicon)[mohamadreza89](/maintainers/mohamadreza89)

---

Top Contributors

[![mohamadrezapishdad](https://avatars.githubusercontent.com/u/34881789?v=4)](https://github.com/mohamadrezapishdad "mohamadrezapishdad (12 commits)")

### Embed Badge

![Health badge](/badges/waxwink-docgen/health.svg)

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

###  Alternatives

[stripe/stripe-php

Stripe PHP Library

4.0k143.3M480](/packages/stripe-stripe-php)[twilio/sdk

A PHP wrapper for Twilio's API

1.6k92.9M271](/packages/twilio-sdk)[knplabs/github-api

GitHub API v3 client

2.2k15.8M187](/packages/knplabs-github-api)[facebook/php-business-sdk

PHP SDK for Facebook Business

90121.9M34](/packages/facebook-php-business-sdk)[meilisearch/meilisearch-php

PHP wrapper for the Meilisearch API

73813.7M114](/packages/meilisearch-meilisearch-php)[google/gax

Google API Core for PHP

263103.1M454](/packages/google-gax)

PHPackages © 2026

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