PHPackages                             lsclh/apidoc - 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. lsclh/apidoc

ActiveLibrary[API Development](/categories/api)

lsclh/apidoc
============

根据fastadmin的文档自动生成思想,借用其模版适配的接口文档自动生成工具

v1.1.1(7y ago)1192PHP

Since Mar 18Pushed 7y agoCompare

[ Source](https://github.com/lsclh/apidoc)[ Packagist](https://packagist.org/packages/lsclh/apidoc)[ RSS](/packages/lsclh-apidoc/feed)WikiDiscussions master Synced yesterday

READMEChangelogDependenciesVersions (4)Used By (0)

\#Api文档自动生成

> 注释功能说明

```
类注释
@ApiSector          类名称(必须)
@ApiRoute           类访问路径(必须)           如:  /api/index (/模块/控制器)

方法注释
@ApiTitle	    API接口的标题(必须)	     如:  登入授权接口
@ApiSummary         API接口的简介(选填)        如:  用户登入授权使用,获取token,用来调取其他接口口令
@ApiRoute           API方法名(必须)           如:  /login
@ApiMethod          API请求方式(选填)         如:  POST (默认GET)
@ApiParams          API请求参数(选填)         如:  {"name":"username","description":"用户账号","required":"是","type":"string"} 多个参数写多@ApiParams即可  type类型支持 int float 生成number input file生成文件input 其他生成text
@ApiReturn          API返回结果示例(选填)      如:  {"code":1,"msg":"订单创建成功","time":"1547608948","data":{"order_num":"201901161122291547608949100241"}}
@ApiReturnParams    API返回参数说明(选填)      如:   {"name":"token","description":"返回口令","required":"是","type":"string"} 多个参数写多个@ApiParams即可
@ApiInternal	    此方法或类将不加入文档(选填)	    无
@Update             此方法正在开发中                   无

```

> 登录接口示例

```
/**
 * @ApiSector 用户信息模块
 * @ApiRoute /api/user
 */
class User
{

    /**
     * @ApiTitle 用户登入
     * @ApiSummary 用户登入授权使用,获取token,用来调取其他接口口令
     * @ApiRoute /login
     * @ApiMethod POST
     * @ApiParams {"name":"username","description":"用户账号/手机号","required":"是","type":"int"}
     * @ApiParams {"name":"password","description":"用户密码","required":"是","type":"string"}
     * @ApiReturn {"code":200,"msg":"登入成功","data":{"token":"c9374c04-07be-4bd2-9e66-267eae37b35f"}}
     * @ApiReturnParams {"name":"token","description":"接口调用口令,登入成功必定返回","required":"是","type":"string"}
     */
    public function login(){

    }
}

```

\###使用方法

> 1 复制目录下的ApiDoc 到启动目录
>
> 2 修改或直接使用命令行生成 php7 ApiDoc App/HttpController/Api Api.html /Temp/ApiDoc/ 项目名 作者

###  Health Score

27

—

LowBetter than 49% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity9

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity62

Established project with proven stability

 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.

###  Release Activity

Cadence

Every ~15 days

Total

3

Last Release

2582d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/327884c6916d1ed7050c078f92c748edc01249b25364746b6abf815ddc14f4fe?d=identicon)[lsclh](/maintainers/lsclh)

---

Top Contributors

[![lsclh](https://avatars.githubusercontent.com/u/48650923?v=4)](https://github.com/lsclh "lsclh (5 commits)")

### Embed Badge

![Health badge](/badges/lsclh-apidoc/health.svg)

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

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