PHPackages                             xinran/laravel-easyapidoc - 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. xinran/laravel-easyapidoc

ActiveLibrary[API Development](/categories/api)

xinran/laravel-easyapidoc
=========================

laravel-easyapidoc

0391HTML

Since Nov 16Pushed 9y ago1 watchersCompare

[ Source](https://github.com/uukk/laravel-easyapidoc)[ Packagist](https://packagist.org/packages/xinran/laravel-easyapidoc)[ RSS](/packages/xinran-laravel-easyapidoc/feed)WikiDiscussions master Synced 3w ago

READMEChangelogDependenciesVersions (1)Used By (0)

laravel-easyapidoc
==================

[](#laravel-easyapidoc)

简介
--

[](#简介)

laravel-easyapidoc 适用于当前最流行的 Laravel 框架的一个扩展库. 便于 Laravel 用户可以很方便地使用它写文档注释.

安装
--

[](#安装)

#### Composer 设置

[](#composer-设置)

首先添加 laravel-easyapidoc 包添加到你的 `composer.json` 文件的 `require` 里:

```
"require": {
	    "xinran/laravel-easyapidoc": "dev-master"
}

```

然后 运行 `composer update`

使用方法
----

[](#使用方法)

1、添加路由

```
Route::get('api', function () {
    $doc = new \XinRan\EasyApiDoc();
    return $doc->getApiDoc();
});

```

2、在你需要写注释的方法上面写注释

3、地址加上 api 就可以访问了

其它
--

[](#其它)

如果接口只在特定环境下访问

```
if (app()->environment('local')) {
   Route::get('api', function () {
       $doc = new \XinRan\EasyApiDoc();
       return $doc->getApiDoc();
   });
}

```

注释参数说明
------

[](#注释参数说明)

```
/**
 * 这里是方法名
 * @name 这里是接口名
 * @group 这里是接口分组
 * @route 这里是路由
 * @method 这里是请求方法
 * @author 这里是作者
 * @description 这里是接口描述
 * @created 这里是接口创建时间 2016-10-25 16:21
 * @updated 这里是接口更新时间 2016-10-25 16:21
 * @param string(参数类型) param(参数名) param(参数说明)
 * @return string(返回参数类型)  message(返回参数) message(返回参数说明)
 * @return array data data
 * @return integer data.id id
 * @return string data.name name
 */

eg.

/**
  * 测试一下
  * @name 测试一下
  * @group 测试分组
  * @route route
  * @method get
  * @author xinran
  * @description 测试一下
  * @created 2016-10-25 16:33
  * @updated 2016-10-25 16:33
  * @param string param param
  * @return integer code code（0:success、other:failed）
  * @return string message message
  * @return array data data
  * @return integer data.id id
  * @return string data.name name
  */

```

###  Health Score

20

—

LowBetter than 13% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity8

Limited adoption so far

Community5

Small or concentrated contributor base

Maturity41

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.

### Community

Maintainers

![](https://www.gravatar.com/avatar/63d407a11518dc015f91fb29decccc4530edeb99b306440206ee2f71c975a37b?d=identicon)[xinran](/maintainers/xinran)

### Embed Badge

![Health badge](/badges/xinran-laravel-easyapidoc/health.svg)

```
[![Health](https://phpackages.com/badges/xinran-laravel-easyapidoc/health.svg)](https://phpackages.com/packages/xinran-laravel-easyapidoc)
```

###  Alternatives

[exsyst/swagger

A php library to manipulate Swagger specifications

35816.3M7](/packages/exsyst-swagger)[hubspot/api-client

Hubspot API client

24015.5M18](/packages/hubspot-api-client)[pocketmine/bedrock-protocol

An implementation of the Minecraft: Bedrock Edition protocol in PHP

172437.8k11](/packages/pocketmine-bedrock-protocol)[botman/driver-telegram

Telegram driver for BotMan

93452.6k6](/packages/botman-driver-telegram)[pixelant/pxa-social-feed

Add Facebook, Instagram, and Twitter feeds to your site.

2349.3k](/packages/pixelant-pxa-social-feed)

PHPackages © 2026

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