README

Api 文档构建工具集中管理现有项目的 API 文档生成和更新。将其作为 cronjob 使用，以便及时获得最新的文档。可在 packagist 和 openhub.net 获取。

versioneye 状态：

工作流程

• 遍历项目路径集合
• 使用 apigen 生成文档
• 创建 index.html
• 执行 git pull 并评估输出以检查是否有工作要做

使用方法

./bin/net_bazzline_api_document_builder path/to/configuration.php

示例

mkdir -p net_bazzline/api_document_builder
cd net_bazzline/api_document_builder
git clone https://github.com/bazzline/api_document_builder/ .
./bin/net_bazzline_api_document_builder example/configuration.php
lynx example/output/index.html

历史记录

• 即将推出
  • @todo
    • 添加 php cs fixer
    • 实现使用 template 的功能
    • 添加指向当前/最新标签（/latest-release）的链接
      • 示例链接： https://github.com/bazzline/php_component_database_file_storage/releases/tag/0.6.2
    • 添加每个标签/版本的链接
    • 添加可选的“演示页面”链接
    • 使用 process pipe 组件重构
    • 使用 requirement 组件重构
    • 实现单元测试
    • 使其动态化
      • 使用 diactoros
      • 生成 index.php 而不是 index.html
      • 添加 htaccess
      • /my_project 应可调用并转换为重定向（如果存在）
    • 轻松添加项目
      • 解析 composer.json
    • 轻松删除项目
      • 删除所有响应代码大于或等于 300 的项
    • 添加更多文档生成器（除了 apigen）
    • 创建工厂
    • 添加 "keep_cache"（布尔值）值
    • 实现缓存和输出清理（如果项目被移动或删除等）
      • 验证 git pull 返回消息
    • 支持多个项目标签
  • @done
    • 添加了 rector
• 1.3.0 - 发布于 2016 年 10 月 23 日
  • 通过在 bug 级别版本上使用星号来放松依赖处理
• 1.2.2 - 发布于 2016 年 3 月 15 日
  • 更新了依赖项
• 1.2.1 - 发布于 2016 年 2 月 29 日
  • 修复了版本眼中的损坏图像
  • 更新了依赖项
• 1.2.0 - 发布于 2016 年 2 月 29 日
  • 迁移到 psr-4 自动加载
• 1.1.9 - 发布于 2016 年 1 月 24 日
  • 更新了依赖项
• 1.1.8 - 发布于 2015年12月18日
  • 更新了依赖项
• 1.1.7 - 发布于 2015年11月19日
  • 更新了依赖项
• 1.1.6 - 发布于 2015年11月14日
  • 更新了依赖项
• 1.1.5 - 发布于 2015年11月8日
  • 更新了依赖项
• 1.1.4 - 发布于 2015年9月25日
  • 更新了依赖项
• 1.1.3 - 发布于 2015年9月18日
  • 更新了依赖项
• 1.1.2 - 发布于 2015年9月13日
  • 更新了依赖项
• 1.1.1 - 发布于 2015年7月4日
  • 更新了依赖项
• 1.1.0
  • 实现了问题/2的功能请求
  • 查看迁移步骤
• 1.0.4
  • 修复了问题/1
• 1.0.3
  • 实现了进度条组件的使用
• 1.0.2
  • 为配置添加了可选的 "tracking_snippet" 支持
  • 使 index.html 有效
• 1.0.1
  • 更新了依赖项
• 1.0.0
  • 初始发布

结语

如果你喜欢它，请给它加星标 :-). 如果需要它，请提交问题。如果你喜欢它，请拉取补丁。如果你在使用它，请写一篇博客。如果你爱它，请捐赠一些东西 :-]。