|Last Updated|| ||Ratings|| ||Unique User Downloads|| ||Download Rankings|| || |
|2015-04-02 (8 months ago) ||Not enough user ratings||Total: 131 ||All time: 7,954 This week: 1,039|
|Description|| ||Author|| || |
This class is a parser for RAML (RESTful API Markup Language) for a given API.
It can parse a given file with the definitions of a REST API in the YAML RAML format.
The class can returns arrays with the details of the API definitions that can be passed to a template processing script that outputs the documentation.
Prize: One copy of DWebPro Standard License
|RAML (REST API Markup Language) is a specification for defining the function calls made available by a given REST API.
This class can parse the definitions of a REST API in RAML format and generates API documentation automatically.
RAML 2 HTML for PHP
RAML 2 HTML for PHP is a simple application that makes use of multiple templates to allow you to build and customize your API Docs using RAML.
What version of PHP does RAML 2 HTML require?
RAML 2 HTML for PHP versions 1.0 or greater require PHP 5.3+
If you are running an older version of PHP, it is highly recommend you upgrade, but if you are unable to do so, you can use RAML version 0.2 which supports PHP 5+. However, this version is extremely limited and is not being maintained or supported.
How do I set it up?
Important setup information is stored in config.php. You can read setup instructions here.
Is there a Demo?
Yes! You can find the latest stable demo and the latest development version demos here.
Does it support all RAML features?
Not yet, although version 1.0 was a complete rewrite supports base, path variables, multi-level includes, traits, and more. Other features will be added down the road!
How Can I Help?
Easy! Download and use RAML 2 HTML for PHP, tell your friends, if you find issues report them, or even better - feel free to contribute by forking and making pull requests!
RAML is covered under the GPL2 license. However, the included class Spyc falls under the MIT license.
||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.