Download the PHP package pkg6/apidoc without Composer

On this page you can find all versions of the php package pkg6/apidoc. 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 pkg6/apidoc

Informations about the package apidoc

PHP-ApiDoc

为基于 PHP 的 API 应用生成文档 无需依赖框架，无需额外依赖。

📋 环境要求

📦 安装

使用 Composer 安装：

🚀 使用方法

在你的类和方法上使用注解：

namespace Pkg6\Apidoc\Tests\TestClasses;

class User
{
    /**
     * @ApiDescription(section="User", description="获取用户信息")
     * @ApiMethod(type="get")
     * @ApiRoute(name="/user/get/{id}")
     * @ApiParams(name="id", type="integer", nullable=false, description="用户ID")
     * @ApiParams(name="data", type="object", sample="{'user_id':'int','user_name':'string','profile':{'email':'string','age':'integer'}}")
     * @ApiReturnHeaders(sample="HTTP 200 OK")
     * @ApiReturn(type="object", sample="{
     *   'transaction_id':'int',
     *   'transaction_status':'string'
     * }")
     */
    public function get() {}

    /**
     * @ApiDescription(section="User", description="创建新用户")
     * @ApiMethod(type="post")
     * @ApiRoute(name="/user/create")
     * @ApiParams(name="username", type="string", nullable=false, description="用户名")
     * @ApiParams(name="email", type="string", nullable=false, description="邮箱")
     * @ApiParams(name="password", type="string", nullable=false, description="密码")
     * @ApiParams(name="age", type="integer", nullable=true, description="年龄")
     */
    public function create() {}
}

⚙️ 生成 API 文档

然后通过命令行执行该文件：

php apidoc.php

生成的API文档将保存在 api.html 。

🧩 支持的注解方法

目前支持以下注解：

💡 小技巧

如果你希望展示复杂对象的输入示例，可以使用 @ApiParams 并设置 type=object|array|array(object)，例如：

@ApiParams(
    name="data", 
    type="object", 
    sample="{'user_id':'int','profile':{'email':'string','age':'integer'}}"
)

🙏 感谢

本项目灵感来源并参考了优秀的开源项目 calinrada/php-apidoc，在此致以诚挚感谢 🙌。

All versions of apidoc with dependencies

PHP Build Version
Package Version
Requires ext-json Version *
php Version >=5.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 pkg6/apidoc contains the following files

Loading the files please wait ...