Download the PHP package busyphp/api-doc without Composer

On this page you can find all versions of the php package busyphp/api-doc. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of busyphp/api-doc

Informations about the package api-doc

BusyPHP ApiDoc 说明

本辅助插件主要用于接口文档自动化生成

书写规范

保留关键字

@、#、*
书写中如果必须使用以上关键字，请转义输入，如：\@，\#，\*

控制器

控制器类必须书写注释，且必须写到 class className { 之上，书写格式为：

方法

API接口方法必须书写注释，且必须写到 public function functionName() { 之上

参数说明

@api 声明接口请求方式，如get 或 post，如：@api post
@param 申明请求参数，可以写多个，格式：@param 参数类型 参数名称 参数说明 [二级参数..]，参数前面加 "*" 号代表这个参数是必填的。二级参数格式：# 参数名称 : 参数说明
@return 声明返回类型和结构，格式：返回类型 [返回结构...]，目前支持 Json返回类型，如：@return Json 返回结构格式：# 参数名称 参数类型 : 参数说明 [多级参数...] 几个"#"号代表几级参数，只有array,object参数类型才会解析多级参数 @example 声明输出示例，可以直接复制测试接口返回的内容 @desc 接口说明

生成文档

在对应要展示文档的控制中使用

All versions of api-doc with dependencies

PHP Build Version
Package Version
Requires busyphp/busyphp Version ^6.0
erusev/parsedown Version 1.7.4
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package busyphp/api-doc contains the following files

Loading the files please wait ....