Download the PHP package xianrenqh/api-doc-v2 without Composer

On this page you can find all versions of the php package xianrenqh/api-doc-v2. 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?

Informations about the package api-doc-v2

Api-Doc-v2

描述:

thinkphp6 API文档自动生成。

如果是thinkphp5,请自行更改下面第三部中apidoc文件夹里的控制器namespace

主要功能:

根据接口注释自动生成接口文档

版本更新:

开源地址:

https://github.com/xianrenqh/api-doc-v2

扩展安装:

方法一:composer命令

composer require xianrenqh/api-doc-php

使用说明:

1、 安装成功之后确认config文件夹下是否创建了 apidoc_v2.php文件,如果没有创建,请复制以下文件到config文件夹下 \vendor\xianrenqh\api-doc-v2\src\config\apidoc_v2.php 或者,直接创建config.php文件并粘贴以下代码:

参数修改说明:

controllers数组中的值是你需要显示的接口api的控制器,例如:

'controllers'     => [
        'api\\controller\\IndexController',
        'api\\controller\\UserController',
    ],

其他字段均有注释。

2、 复制静态文件到你的public下(如果前端文件没有): \vendor\xianrenqh\api-doc-v2\demo\static 所有文件夹

3、 复制执行控制器到你的app项目下: \vendor\xianrenqh\api-doc-v2\demo\apidoc 所有文件夹

apidoc文件夹可以重命名,但是命名后需要更改对应控制器中namespace

4、以上完成后,访问网址: http://你的域名/apidoc

在接口控制器中使用:

新建一接口控制器,例如:\app\api\controller\UserController.php 代码:

以上代码中的注释,即自动会展示在接口文档中


All versions of api-doc-v2 with dependencies

PHP Build Version
Package Version
Requires php Version >=7.1.0
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 xianrenqh/api-doc-v2 contains the following files

Loading the files please wait ....