Download the PHP package bernardosecades/split-blue without Composer
On this page you can find all versions of the php package bernardosecades/split-blue. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download bernardosecades/split-blue
More information about bernardosecades/split-blue
Files in bernardosecades/split-blue
Package split-blue
Short Description Split Blueprint files (request/response sections) to generate documentation and mock servers files
License MIT
Informations about the package split-blue
SplitBlue
API Blueprint renderer.
You can split your API blueprint document with request/response (text-plain, json, xml ...) files and include in your main document to easily maintenance.
If you need load mock server with these API blueprint documents you can process them to render all content in unique file (including content request/response files) and load this file in mock server like drakov or similar.
The html documentation will be generated from that unique file.
Installation
This tool use markdown-pp and aglio to include request/response files in API blueprint documents and generate html documentation.
You can execute shell script to install MarkdownPP
and Aglio
:
Or install step by step next commands:
Install markdown-pp
Install aglio
Install some dependencies with composer
Usage
Example apib file:
Where file Response\a.xml
will have:
If you execute command `./bin/split-blue c
from this tool you will generate two files:
- Build/out.apib (with content of a.xml file)
- Build/out.html (documentation html of your API with content a.xml file)
The content of file Build/out.apib
will be:
It will be ready to load in your mock server.
Generate HTML Documentation and files to load in Mock Server
Example 1:
It will try to search all files named like index.apib
to process include sentences of that file
and generate output files (out.apib
and out.html
) in folder Build
, if this not exist it will create it in the same level that index.apib
file
Example content index.apib
:
So this command will generate files:
- md/example/MyAPI/V1/Compile/Build/out.apib
- md/example/MyAPI/V1/Compile/Build/out.html
- md/example/MyAPI/V2/Compile/Build/out.apib
- md/example/MyAPI/V2/Compile/Build/out.html
Example 2:
- md/example/MyAPI/V2/Compile/Build/out.apib
- md/example/MyAPI/V2/Compile/Build/out.html
It will generate files:
Tests
You can execute integration tests with next command:
Screenshots
./bin/split-blue c md/example/MyAPI/V2
All versions of split-blue with dependencies
symfony/console Version ^2.2|^3.0
symfony/process Version ^2.2|^3.0
symfony/finder Version ^2.2|^3.0
symfony/filesystem Version ^2.2|^3.0