PHPackages                             older-w/laravel-restful-api-doc - 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. older-w/laravel-restful-api-doc

ActiveLibrary[API Development](/categories/api)

older-w/laravel-restful-api-doc
===============================

a tool for generate api document for laravel

123PHP

Since Jul 30Pushed 7y agoCompare

[ Source](https://github.com/older-w/laravel-restful-api-doc)[ Packagist](https://packagist.org/packages/older-w/laravel-restful-api-doc)[ RSS](/packages/older-w-laravel-restful-api-doc/feed)WikiDiscussions master Synced 2mo ago

READMEChangelogDependenciesVersions (1)Used By (0)

laravel-restful-api-doc
=======================

[](#laravel-restful-api-doc)

a tool for generate api document for laravel

Installation
============

[](#installation)

1、安装扩展

```
composer require older-w/laravel-restful-api-doc

```

2、发布配置

```
php artisan vendor:publish --provider="OlderW\RestfulDoc\RestfulServiceProvider"

```

默认配置
====

[](#默认配置)

配置中的pusher并不可以直接使用，大家可以创建自己pusher。配置说明如下

```
return [
    /**
     * 定义发布方式和参数
     */
    'pusher'=>[
        'wordpress'=>[
            'key'=>'key',
            'user_id'=>'60',
            'url'=>'https://doc.com/wp-admin/admin-ajax.php?action=edit_api',
            'docs'=>[
                'api'=>['id'=>638],
                'error'=>['id'=>638],
                'enum'=>['id'=>638],
            ]
        ]
    ],
    /**
     * 定义采用的发布方式
     */
    'publisher' =>'OlderW\RestfulDoc\Pusher\Wordpress',
    /**
     * 定义处理格式化的类
     */
    'formatter' =>'OlderW\RestfulDoc\DocFormat',
    /**
     * 定义各个文档类型
     */
    'docs'=>[
        'api'=>[
            'path'=>'/app/Http/Controllers/Api',
            'base_class'=>\App\Http\Controllers\Api::class,
            'type'=>'api'
        ],
        'error'=>[
            'path'=>'/app/Http/Exceptions',
            'base_class'=>\App\Http\Exception::class,
            'type'=>'error'
        ],
        'enum'=>[
            'path'=>'/app/Http/Controllers/Api',
            'base_class'=>\App\Http\Controllers\Api::class,
            'type'=>'enum'
        ],
    ],

];

```

- pusher定义的发布方式，目前的wordpress为个人使用配置的，需要在wordpress安装扩展，没有通用性。大家可以自己创建一个pusher使用，创建一个新的pusher 需要实现OlderW\\RestfulDoc\\Interfaces\\DocPusher的接口
- publisher 定义使用哪个pusher
- formatter 定义使用的格式化，自定义可以实现\\OlderW\\RestfulDoc\\Interfaces\\DocFormat接口
- docs 定义了目前支持的类型
- api 文档
- error 错误
- enum 枚举

###  Health Score

21

—

LowBetter than 19% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity8

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity40

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 90.9% 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/d14b8cd57008998ae663ef89af4430a943cda15f86484d6c1213bd88e8fbebd0?d=identicon)[older-w](/maintainers/older-w)

---

Top Contributors

[![phper5](https://avatars.githubusercontent.com/u/29189650?v=4)](https://github.com/phper5 "phper5 (10 commits)")[![older-w](https://avatars.githubusercontent.com/u/41049092?v=4)](https://github.com/older-w "older-w (1 commits)")

### Embed Badge

![Health badge](/badges/older-w-laravel-restful-api-doc/health.svg)

```
[![Health](https://phpackages.com/badges/older-w-laravel-restful-api-doc/health.svg)](https://phpackages.com/packages/older-w-laravel-restful-api-doc)
```

###  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)