PHPackages                             birhanu/laradocs - 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. birhanu/laradocs

ActiveLibrary[API Development](/categories/api)

birhanu/laradocs
================

Laravel API documentation generator

v1.0.0(1y ago)091MITPHP

Since Dec 27Pushed 1y ago1 watchersCompare

[ Source](https://github.com/Birhanu-worku1811/laradocs)[ Packagist](https://packagist.org/packages/birhanu/laradocs)[ RSS](/packages/birhanu-laradocs/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (1)DependenciesVersions (2)Used By (0)

LaraDocs | [View The Published Package](https://packagist.org/packages/birhanu/laradocs)
========================================================================================

[](#laradocs--view-the-published-package)

Team Members
============

[](#team-members)

NameIDArarsa DereseETS0152/13Birhanu WorkuETS0279/13Biruk MesfinETS0290/13Bisrat KebereETS0306/13Biyaol MesayETS0309/13LaraDocs is a Laravel package that generates API documentation for your Laravel application. It provides both JSON and HTML formats for the documentation, making it easy to integrate and use.

Features
--------

[](#features)

- Automatically generates API documentation for your Laravel application.
- Provides both JSON and HTML formats for the documentation.
- Customizable HTML output with a modern, attractive design.
- Easy to set up and use.

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

[](#installation)

1. **Install the package via Composer:**

    ```
    composer require birhanu/laradocs
    ```
2. **Publish the configuration and view files:**

    ```
    php artisan vendor:publish --provider="Birhanu\Laradocs\LaradocsServiceProvider" --tag="config"
    php artisan vendor:publish --provider="Birhanu\Laradocs\LaradocsServiceProvider" --tag="views"
    ```
3. **Add the service provider to your `config/app.php` file (if not using auto-discovery):**

    ```
    'providers' => [
        // Other service providers...
        Birhanu\Laradocs\LaradocsServiceProvider::class,
    ],
    ```

Configuration
-------------

[](#configuration)

The configuration file `config/laradocs.php` allows you to customize the behavior of the package. Here are some of the key options:

- `enabled`: Enable or disable the package.
- `api_prefix`: The prefix for the API documentation routes.
- `default_format`: The default format for the documentation (`json` or `html`).
- `output_format`: The format for the generated documentation files (`json` or `yaml`).
- `output_path`: The path where the generated documentation files will be saved.
- `html_output`: Enable or disable HTML output.

Usage
-----

[](#usage)

**Access the documentation:**

```
- JSON format: `http://your-app-url/api-docs/json`
- HTML format: `http://your-app-url/api-docs`

```

Customization
-------------

[](#customization)

You can customize the HTML output by editing the Blade view file located at `resources/views/vendor/laradocs/custom-ui.blade.php`.

Testing
-------

[](#testing)

To run the tests, use the following command:

```
phpunit
```

License
-------

[](#license)

LaraDocs is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).

###  Health Score

25

—

LowBetter than 37% of packages

Maintenance41

Moderate activity, may be stable

Popularity5

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity38

Early-stage or recently created project

 Bus Factor1

Top contributor holds 75% 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

Unknown

Total

1

Last Release

499d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/6e2f36f39b9392b24554c3aa6989f2878ae254fe6f76b06ac10a895dec57cd4a?d=identicon)[Birhanu-worku1811](/maintainers/Birhanu-worku1811)

---

Top Contributors

[![Birhanu-worku1811](https://avatars.githubusercontent.com/u/121731292?v=4)](https://github.com/Birhanu-worku1811 "Birhanu-worku1811 (3 commits)")[![BisRyy](https://avatars.githubusercontent.com/u/87482476?v=4)](https://github.com/BisRyy "BisRyy (1 commits)")

### Embed Badge

![Health badge](/badges/birhanu-laradocs/health.svg)

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

###  Alternatives

[stripe/stripe-php

Stripe PHP Library

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

A PHP wrapper for Twilio's API

1.6k92.9M270](/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.1M452](/packages/google-gax)

PHPackages © 2026

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