PHPackages                             caps/laravelapi - 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. caps/laravelapi

ActiveLibrary[API Development](/categories/api)

caps/laravelapi
===============

Automatic generation of laravel API documents

101PHP

Since Jan 13Pushed 5y ago1 watchersCompare

[ Source](https://github.com/jiaoyang3/laravelapi)[ Packagist](https://packagist.org/packages/caps/laravelapi)[ RSS](/packages/caps-laravelapi/feed)WikiDiscussions main Synced 5d ago

READMEChangelogDependenciesVersions (1)Used By (0)

LaravelApi
==========

[](#laravelapi)

Automatic generation of laravel API documents

Version Compatibility
---------------------

[](#version-compatibility)

PHPLaravel>=7.2>=5.5Documentation
-------------

[](#documentation)

### Install

[](#install)

composer require caps/laravelapi

### add provider

[](#add-provider)

edit app\\Providers\\AppServiceProvider.php

```
public function boot()
{
    if ($this->app->environment() !== 'production') {
        $this->app->register(LaravelApiProvider::class);
    }
}

```

### edit config file

[](#edit-config-file)

you can copy `laravelapi/config/generate_api.php` into `config` folder
definition `project_name` free

### Usage

[](#usage)

The usage is very simple
Just define @desc before the class
Just define @rule/@return/@exception before the class

example

```
/**
 * 测试队列使用
 * Class PodcastController
 * @package App\Http\Controllers\API
 */
class PodcastController extends Controller
{
    /**
     * 入队列
     * @decc 入队列
     * @rule string product_id 产品ID required
     * @rule int status 状态 required
     * @rule string company_name 所属企业
     * @rule string category_name 产品类型名称 required
     * @rule string name 产品名称 required
     * @return string product_id 产品ID
     * @return string code 产品编码(系统)
     * @return string status 状态
     * @return string company_name 所属企业
     * @return string category_name 产品类型名称
     * @return string category_code 产品类型编码
     * @return string name 产品名称
     * @return string model 产品编码(企业）
     * @return string bundle_amount 产品装箱规格
     * @return string buyer_company 可见企业
     * @return string remark 产品备注
     * @return \Illuminate\Http\JsonResponse
     */
    public function store()
    {
        return response()->json(['msg' => '队列添加成功']);
    }

    /**
     * 测试
     * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
     */
    public function test()
    {
        return view('api_list');
    }
}

```

**last you can visit `http://{website}/gapi/docs` to Preview effect**
\*\*have fun !!! \*\*

Thinks
------

[](#thinks)

Thank you very much for `phalapi`, api document inspiration source `phalapi`
`phalapi` is a very simple and easy to use PHP framework, Its api documentation is so elegant that I want to port it to the laravel framework

###  Health Score

16

—

LowBetter than 5% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity3

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity31

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://avatars.githubusercontent.com/u/16442941?v=4)[xuansu](/maintainers/xuansu)[@Xuansu](https://github.com/Xuansu)

---

Top Contributors

[![jiaoyang3](https://avatars.githubusercontent.com/u/37996610?v=4)](https://github.com/jiaoyang3 "jiaoyang3 (6 commits)")

### Embed Badge

![Health badge](/badges/caps-laravelapi/health.svg)

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

###  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.9M272](/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)