PHPackages                             biggold/apidoc-for-laravel - 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. biggold/apidoc-for-laravel

ActiveComposer-plugin[API Development](/categories/api)

biggold/apidoc-for-laravel
==========================

apidoc-for-laravel

1.0.1(7y ago)01MITPHPPHP >=7.1.0

Since Jul 11Pushed 7y ago1 watchersCompare

[ Source](https://github.com/jarvis130/apidoc-for-laravel)[ Packagist](https://packagist.org/packages/biggold/apidoc-for-laravel)[ RSS](/packages/biggold-apidoc-for-laravel/feed)WikiDiscussions master Synced 2w ago

READMEChangelogDependencies (1)Versions (2)Used By (0)

larvel接口文档生成,测试工具生成工具
=====================

[](#larvel接口文档生成测试工具生成工具)

> 目前已经是基本可用版本，不过测试工具返回类型只有json类型

基本使用方法
======

[](#基本使用方法)

1. composer 安装包:

> composer require biggold/apidoc-for-laravel

2. 配置服务提供者, config/app.php

> 'providers' => \[ Biggold\\Apidoc\\ApiDocServiceProvider::class \]

3. 在controller方法上编写文档,具体编写见下面"文档编写规则"
4. 生成文档(生成前会删除所有文档): php artisan doc:generate
5. 查看文档:
6. 清空所有文档: php artisan doc:cleanall

基本用法生成物描述
=========

[](#基本用法生成物描述)

生成物包含文档页和测试工具页，下面是截图:
文档图片: [![](resources/example/doc.png)](resources/example/doc.png)工具图片: [![](resources/example/tool.png)](resources/example/tool.png)

文档编写方法：
=======

[](#文档编写方法)

### 基本模板

[](#基本模板)

```
    /**
     * @name 用户中心-登录
     * @description 用户登录接口
     * @param username:登录邮箱 @ParamTest zhangwei0933@126.com
     * @param password:登录密码 @ParamTest 12345678
     *
     * @response 通用格式:{"code":响应码,"message":"错误描述","data":{}}
     * data{
     *    userid:"用户id，值为0表示用户未登录",
     *    nickname: "用户昵称",
     *    expired: 最后有效时间（时间戳秒）,-1
     * }
     */
     public function login(Request $request){}
```

```
    Route::group(['prefix' => 'auth', 'middleware'=>[], 'grouptitle'=>'用户中心'], function(){
        Route::post('login','Auth\LoginController@login')->name("auth.login");
    });
```

### 标签描述

[](#标签描述)

> 标签解析规则方法注释中@开头，空格结尾，空格过后是标签内容两边的空格将去掉,内容内的@xxx将不作为标签识别，参数标签@Param做了特殊处理可以包含默认参数测试标签@ParamTest

#### @name

[](#name)

> 接口名称

#### @description

[](#description)

> 接口描述

#### @param

[](#param)

> 参数标签，代表http请求的参数描述，格式如下:@Param 参数名称:参数描述 @ParamTest 参数默认测试值(会自动填充到测试表单中)

#### @response

[](#response)

> 参数结果描述，显示时候显示在<pre></pre>中保存格式

### 接口分组

[](#接口分组)

> 文档中支持用户分组的,如模板中使用'grouptitle'=>'用户中心'为路由分组命名为"用户中心"，这将在文档中体现，如果没有这个分组标题，将不在文档中体现分组,文档上最好是一层分组，如果有多层将一次显示，但是没有层次缩进

###  Health Score

23

—

LowBetter than 26% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity1

Limited adoption so far

Community4

Small or concentrated contributor base

Maturity58

Maturing project, gaining track record

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

2911d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/6269284?v=4)[Jarvis](/maintainers/jarvis130)[@jarvis130](https://github.com/jarvis130)

### Embed Badge

![Health badge](/badges/biggold-apidoc-for-laravel/health.svg)

```
[![Health](https://phpackages.com/badges/biggold-apidoc-for-laravel/health.svg)](https://phpackages.com/packages/biggold-apidoc-for-laravel)
```

###  Alternatives

[symfony/runtime

Enables decoupling PHP applications from global state

74794.9M945](/packages/symfony-runtime)[drupal/core-composer-scaffold

A flexible Composer project scaffold builder.

5344.1M527](/packages/drupal-core-composer-scaffold)[drupal/core-project-message

Adds a message after Composer installation.

2124.0M194](/packages/drupal-core-project-message)[bunq/sdk_php

bunq PHP SDK

89236.5k2](/packages/bunq-sdk-php)[altis/core

Core module for Altis

19222.5k2](/packages/altis-core)[altis/local-server

Local Server module for Altis

18217.0k2](/packages/altis-local-server)

PHPackages © 2026

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