Download the PHP package opqnext/reflection-api-doc without Composer
On this page you can find all versions of the php package opqnext/reflection-api-doc. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
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 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.
Informations about the package reflection-api-doc
reflection_api_doc
这是一个基于 thinkphp5.0 的PHP自动生成api文档的库
两种使用方式，1.composer安装使用。2.tp5独立安装使用。
composer 方式安装
- 安装：
安装有两种方法:
直接执行:
或者修改composer.json文件
我的composer.json示例:
- 使用方法
在 application/extra 目录下创建文件名为 documents.php 的配置文件。
配置文件内容如下：
其中 template 为模板类型，暂时提供两种模板风格，分别为苹果绿和葡萄紫，虽然两套模板都是巨丑无比。所以使用的过程中也可以自己开发模板。
重点: class 为将要生成文档的类(带命名空间)
- 示例：
| 注释参数 | 含义 | 说明 |
|---|---|---|
| @title | 标题 | 文档生成的类方法标题 |
| @desc | 描述 | 格式如下，地址、请求方式、备注等 |
| @param | 接收参数 | 格式如下，name:名称、type:类型、required:是否必须、default:默认值、desc:说明 |
| @return | 返回参数 | 格式如下，name:名称、type:类型、required:是否必须、desc:说明、level：层级 |
类的具体实现方法：
编辑好配置文件之后 直接打开浏览器访问 http://localhost/api/documents 即可看到文档页。
demo预览地址:http://beta.tp.opqnext.com:8086/api/documents
注意: 项目中 extend 目录为独立安装使用包。如果你使用composer安装，并且觉得 extend 目录极其碍眼，可以将其删除，并不影响正常使用。(^o^)/~
tp5独立安装使用
- 安装
直接下载或者拷贝目录extend下的reflection，放到项目的extend下。
- 使用方法
同样的，在 application/extra 目录下创建文件名为 documents.php 的配置文件。文件内容如上所示。
在 application 目录下的 common.php 文件中填加如下内容：
编辑好配置文件之后 直接打开浏览器访问 http://localhost/doc 即可看到文档页。
demo预览地址:http://beta.tp.opqnext.com:8086/doc
- 预览
长相一般的苹果绿：
长相也一般的葡萄紫：
-
thinkphp5.1需要自行修改Documents类。
- 支持
如果有使用自动生成文档的需求或者之类的，欢迎加入 QQ群:452209691 共同探讨。
