Download the PHP package melody-chen/api-auto-doc without Composer
On this page you can find all versions of the php package melody-chen/api-auto-doc. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Table of contents
Download melody-chen/api-auto-doc
More information about melody-chen/api-auto-doc
Files in melody-chen/api-auto-doc
Download melody-chen/api-auto-doc
More information about melody-chen/api-auto-doc
Files in melody-chen/api-auto-doc
Vendor melody-chen
Package api-auto-doc
Short Description auto upload api to sdk platform
License MIT
Package api-auto-doc
Short Description auto upload api to sdk platform
License MIT
Please rate this library. Is it a good library?
Informations about the package api-auto-doc
apiautodoc
php自动生成api文档,无需依赖任何framework(基于crada/php-apidoc改动).提供了查看某个API的页面,访问所有API需提供密码才能查看.
Generate documentation for php API based application. No dependency. No framework required.(base crada/php-apidoc)
Requirements
PHP >= 7.1
Installation
- 添加至composer.json
- The recommended installation is via composer. Just add the following line to your composer.json:
Usage/使用示例
-
函数注释文档示例/Example of function comment documentation
-
创建执行生成API文档/Create an apidoc.php file in your project root folder as follow:
- 然后执行创建API文档文件/Then, execute it via CLI
函数注释/Available Methods
- @ApiDescription(section="...", description="...")
- @ApiMethod(type="(get|post|put|delete|patch")
- @ApiRoute(name="...")
- @ApiParams(name="...", type="...", nullable=..., description="...", [sample=".."])
- @ApiHeaders(name="...", type="...", nullable=..., description="...")
- @ApiReturnHeaders(sample="...")
- @ApiReturn(type="...", sample="...")
- @ApiBody(sample="...")
ps:放不了图片,示例就不展示了。无论是tp还是laravel等等都可以使用该框架,这套我的主要用于做开放平台使用
All versions of api-auto-doc with dependencies
PHP Build Version
Package Version
Requires
php Version
>=7.1
The package melody-chen/api-auto-doc contains the following files
Loading the files please wait ....