Last Updated | | Ratings | | Unique User Downloads | | Download Rankings |
2020-03-18 (11 days ago) | | Not yet rated by the users | | Total: 27 This week: 6 | | All time: 9,828 This week: 64 |
|
Description | | Author |
This package can be used to generate automatic documentation for APIs.
It provides a script to be run from the command line to use a given configuration script that specifies the details of several APIs to generate documentation.
The package uses the APIGen to generate documentation for those projects and created an index.html page to link to the generated documentation.
It can also pull the project of a Git repository to check if the documentation needs to be generated. | |
|
|
Innovation award
Nominee: 6x |
|
Details
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 and openhub.net.
The versioneye status is:
Work Flow
- iterating over collection of project paths
- generates documentation using apigen
- creates index.html
- do a git pull and evaluates the output to check if there is work to do
Usage
./bin/net_bazzline_api_document_builder path/to/configuration.php
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
- upcomming
* @todo
* implement usage of template
* add link to current / latest tag (<path>/latest-release)
* example link: 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 component
* refactor by using the requirement component
* implement unit tests
* make it dynamically
* use diactoros
* generate a index.php instead of a index.html
* add htaccess
* <url>/my_project should be callable and transform into a redirect (if exists)
* easy up adding project
* <add> <url to composer.json>
* parse composer.json
* easy up deleting project
* <validate>
* 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
- 1.3.0 - released at 23.10.2016
* releaxed dependency handling by using the asterix on the bug level version
- 1.2.2 - released at 15.03.2016
* updated dependencies
- 1.2.1 - released at 29.02.2016
* fixed broken image for version eye
* updated dependency
- 1.2.0 - released at 29.02.2016
* moved to psr-4 autoloading
- 1.1.9 - released at 24.01.2016
* updated dependency
- 1.1.8 - released at 18.12.2015
* updated dependency
- 1.1.7 - released at 19.11.2015
* updated dependency
- 1.1.6 - released at 14.11.2015
* updated dependency
- 1.1.5 - released at 08.11.2015
* updated dependency
- 1.1.4 - released at 25.09.2015
* updated dependency
- 1.1.3 - released at 18.09.2015
* updated dependency
- 1.1.2 - released at 13.09.2015
* updated dependency
- 1.1.1 - released at 04.07.2015
* updated dependency
- 1.1.0
* implemented feature request of issue/2
* see migration steps
- 1.0.4
* fixed issue/1
- 1.0.3
* implemented usage of progress bar component
- 1.0.2
* added optional "tracking_snippet" support for configuration
* made index.html valid
- 1.0.1
* updated dependency
- 1.0.0
* initial release
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 if you love it :-].
|
Applications that use this package |
|
No pages of applications that use this class were specified.
If you know an application of this package, send a message to the author to add a link here.