PHPackages                             net\_bazzline/api\_document\_builder - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. net\_bazzline/api\_document\_builder

ActiveLibrary[API Development](/categories/api)

net\_bazzline/api\_document\_builder
====================================

free as in freedom php api document builder

1.3.0(9y ago)115[2 issues](https://github.com/bazzline/api_document_builder/issues)GPL-3.0PHPPHP &gt;=5.3.3

Since Jun 5Pushed 1y ago4 watchersCompare

[ Source](https://github.com/bazzline/api_document_builder)[ Packagist](https://packagist.org/packages/net_bazzline/api_document_builder)[ RSS](/packages/net-bazzline-api-document-builder/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (9)Versions (17)Used By (0)

Api Document Builder
====================

[](#api-document-builder)

Api document builder centralize api documentation generation and updating of existing projects. Use it as a cronjob to have the latest documentation in time. Available at [packagist](https://packagist.org/packages/net_bazzline/api_document_builder) and [openhub.net](https://openhub.net/p/api_document_builder).

The versioneye status is: [![Dependency Status](https://camo.githubusercontent.com/95f9454304087fa79f6fbe54cc00270576fe21c2f55ad787b6e5ba0e40ce4679/68747470733a2f2f7777772e76657273696f6e6579652e636f6d2f757365722f70726f6a656374732f3535663561353838616432663638303030643030303635312f62616467652e7376673f7374796c653d666c6174)](https://www.versioneye.com/user/projects/55f5a588ad2f68000d000651)

Work Flow
=========

[](#work-flow)

- iterating over collection of project paths
- generates documentation using [apigen](https://github.com/ApiGen/ApiGen)
- creates index.html
- do a git pull and evaluates the output to check if there is work to do

Usage
=====

[](#usage)

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

```

Example
=======

[](#example)

```
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

```

History
=======

[](#history)

- upcomming
    - @todo
        - Add [php cs fixer](https://github.com/PHP-CS-Fixer/PHP-CS-Fixer)
        - implement usage of [template](https://github.com/bazzline/php_component_template/)
        - add link to current / latest tag (/latest-release)
            - example link: [https://github.com/bazzline/php\_component\_database\_file\_storage/releases/tag/0.6.2](https://github.com/bazzline/php_component_database_file_storage/releases/tag/0.6.2)
        - add links for each tag/release
        - add optional link to "demo page"
        - refactor by using the [process pipe](https://github.com/bazzline/php_component_process_pipe) component
        - refactor by using the [requirement](https://github.com/bazzline/php_component_requirement) component
        - implement unit tests
        - make it dynamically
            - use [diactoros](https://github.com/zendframework/zend-diactoros)
            - generate a index.php instead of a index.html
            - add htaccess
            - /my\_project should be callable and transform into a redirect (if exists)
        - easy up adding project
            -
            - parse composer.json
        - easy up deleting project
            -
            - deletes all where response code is greater or equal 300
        - add more documentation generators (beside apigen)
        - create factories
        - add "keep\_cache" (boolean) value
        - implement cache and output cleanup (if project is moved or deleted etc.)
            - validate git pull return message
        - supporting multiple project tags
    - @done
        - Added rector
- [1.3.0](https://github.com/bazzline/api_document_builder/tree/1.3.0) - released at 23.10.2016
    - releaxed dependency handling by using the asterix on the bug level version
- [1.2.2](https://github.com/bazzline/api_document_builder/tree/1.2.2) - released at 15.03.2016
    - updated dependencies
- [1.2.1](https://github.com/bazzline/api_document_builder/tree/1.2.1) - released at 29.02.2016
    - fixed broken image for version eye
    - updated dependency
- [1.2.0](https://github.com/bazzline/api_document_builder/tree/1.2.0) - released at 29.02.2016
    - moved to psr-4 autoloading
- [1.1.9](https://github.com/bazzline/api_document_builder/tree/1.1.9) - released at 24.01.2016
    - updated dependency
- [1.1.8](https://github.com/bazzline/api_document_builder/tree/1.1.8) - released at 18.12.2015
    - updated dependency
- [1.1.7](https://github.com/bazzline/api_document_builder/tree/1.1.7) - released at 19.11.2015
    - updated dependency
- [1.1.6](https://github.com/bazzline/api_document_builder/tree/1.1.6) - released at 14.11.2015
    - updated dependency
- [1.1.5](https://github.com/bazzline/api_document_builder/tree/1.1.5) - released at 08.11.2015
    - updated dependency
- [1.1.4](https://github.com/bazzline/api_document_builder/tree/1.1.4) - released at 25.09.2015
    - updated dependency
- [1.1.3](https://github.com/bazzline/api_document_builder/tree/1.1.3) - released at 18.09.2015
    - updated dependency
- [1.1.2](https://github.com/bazzline/api_document_builder/tree/1.1.2) - released at 13.09.2015
    - updated dependency
- [1.1.1](https://github.com/bazzline/api_document_builder/tree/1.1.1) - released at 04.07.2015
    - updated dependency
- [1.1.0](https://github.com/bazzline/api_document_builder/tree/1.1.0)
    - implemented feature request of [issue/2](https://github.com/bazzline/api_document_builder/issues/2)
    - see [migration steps](https://github.com/bazzline/api_document_builder/blob/master/migration/from_1.0.x_to_1.1.0.md)
- [1.0.4](https://github.com/bazzline/api_document_builder/tree/1.0.4)
    - fixed [issue/1](https://github.com/bazzline/api_document_builder/issues/1)
- [1.0.3](https://github.com/bazzline/api_document_builder/tree/1.0.3)
    - implemented usage of [progress bar](https://github.com/bazzline/php_component_cli_progress_bar) component
- [1.0.2](https://github.com/bazzline/api_document_builder/tree/1.0.2)
    - added optional "tracking\_snippet" support for configuration
    - made index.html valid
- [1.0.1](https://github.com/bazzline/api_document_builder/tree/1.0.1)
    - updated dependency
- [1.0.0](https://github.com/bazzline/api_document_builder/tree/1.0.0)
    - initial release

Final Words
===========

[](#final-words)

Star it if you like it :-). Add issues if you need it. Pull patches if you enjoy it. Write a blog entry if you use it. [Donate something](https://gratipay.com/~stevleibelt) if you love it :-\].

###  Health Score

25

—

LowBetter than 37% of packages

Maintenance8

Infrequent updates — may be unmaintained

Popularity7

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity66

Established project with proven stability

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~33 days

Recently: every ~77 days

Total

16

Last Release

3494d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/58451b041f6f5a38c7e62762c96d01f5e2bcac30e322707fe4760a82bccb6856?d=identicon)[artodeto](/maintainers/artodeto)

---

Top Contributors

[![stevleibelt](https://avatars.githubusercontent.com/u/2287220?v=4)](https://github.com/stevleibelt "stevleibelt (36 commits)")

---

Tags

psrphpapibuilderbazzlinefree as in freedomPSR-4documentgpl

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/net-bazzline-api-document-builder/health.svg)

```
[![Health](https://phpackages.com/badges/net-bazzline-api-document-builder/health.svg)](https://phpackages.com/packages/net-bazzline-api-document-builder)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
