README

使用注解生成PHP API文档。无依赖。无需框架。

预览
要求
安装
使用
选项
注解
自定义输出HTML
已知问题
致谢

预览

您可以通过Client和Document查看基于示例生成的文档。

http://zckrs.github.io/php-gen-doc-api/

要求

无依赖。无需框架。在Packagist.org上查看View on Packagist.org

只需PHP >= 5.3.2。

安装

推荐使用composer进行安装。只需将以下行添加到您的composer.json文件中

{
    ...
    "require": {
        ...
        "zckrs/php-gen-doc-api": "@dev"
    }
}

$ php composer.phar update

使用

在项目根目录中复制genDocApi.php文件，例如。
在此新文件中设置选项。
通过CLI执行： php genDocApi.php
您将获得一个新的HTML文件。（默认选项存储在web/index.html中）

选项

apiName

当前API的名称，在生成的文件顶部显示（默认：php-gen-doc-api）。

apiDescription

当前API的描述，在生成的文件顶部显示（默认：无值）。

outputFile

生成文件的名称（默认：index.html）。

outputDir

存储HTML文件的目录（默认：/web）。

templateDir

存储视图的目录（默认：/src/Resources/views）。

您可以覆盖视图。请参阅如何自定义输出HTML

assetDir

存储资产的目录（默认：/src/Resources/assets）。

您可以覆盖资产。请参阅如何自定义输出HTML

注释

自定义输出HTML

默认 layout.html 包含的内容

Bootstrap v3.1.1
jQuery v1.10.2
Google Code Prettify

如何自定义输出HTML

为视图创建一个主目录。
在 genDocApi.php 中定义 template_dir 选项。
放置具有相同模型树的自定义视图。详细视图
每个视图包含一些 {{ variables }}

已知问题

如果您有任何问题或改进建议，请通过 GitHub 联系我。

致谢

本项目受到基于 Swagger 的 Calinrada 的 php-apidoc 的启发，并使用由 Eriknyk 编写的 Extractor.php。

zckrs / php-gen-doc-api

维护者

详细信息