PHP Classes
elePHPant
Icontem

PHP RAML to HTML: Parse RAML of an API to generate documentation

Recommend this page to a friend!
Stumble It! Stumble It! Bookmark in del.icio.us Bookmark in del.icio.us
  Info   View files Example   View files View files (16)   DownloadInstall with Composer Download .zip   Reputation   Support forum (1)   Blog    
Last Updated Ratings Unique User Downloads Download Rankings  
2015-04-02 (2 months ago) RSS 2.0 feedNot enough user ratingsTotal: 124 All time: 7,839 This week: 1,067Up
Version License PHP version Categories  
raml2html 1.1GNU General Publi...5.3PHP 5, Web services, Parsers
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.

Innovation Award  
PHP Programming Innovation award nominee
September 2014
Number 6


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.

Manuel Lemos
Picture of Mike Stowe
Name: Mike Stowe is available for providing paid consulting. Contact Mike Stowe .
Classes: 6 packages by
Country: United States United States
Age: 30
All time rank: 1405190 in United States United States
Week rank: 584 Up68 in United States United States Up
Innovation award
Innovation award
Nominee: 2x

Details provided by the author  

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.

Screenshot

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!

License

RAML is covered under the GPL2 license. However, the included class Spyc falls under the MIT license.

  Files folder image Files  
File Role Description
Files folder imageinc (4 files)
Files folder imageraml (3 files)
Files folder imagetemplates (1 directory)
Accessible without login Plain text file config.php Conf. Configuration script
Accessible without login Plain text file index.php Example Application script
Accessible without login Plain text file README.md Data Auxiliary data

  Files folder image Files  /  inc  
File Role Description
  Plain text file raml.php Class Class source
  Plain text file ramlDataObject.php Class Class source
  Plain text file ramlPathObject.php Class Class source
  Plain text file spyc.php Class Class source

  Files folder image Files  /  raml  
File Role Description
  Accessible without login Plain text file github.raml Data GitHub RAML File
  Accessible without login Plain text file githubrepo.raml Data Auxiliary data
  Accessible without login Plain text file songs.raml Data Auxiliary data

  Files folder image Files  /  templates  
File Role Description
Files folder imagegrey (6 files)

  Files folder image Files  /  templates  /  grey  
File Role Description
  Accessible without login Plain text file index.phtml Aux. Sample output
  Accessible without login Plain text file _404.phtml Data Sample output
  Accessible without login Plain text file _action.phtml Appl. Sample output
  Accessible without login Plain text file _menu.phtml Aux. Sample output
  Accessible without login Plain text file _resources.phtml Aux. Sample output
  Accessible without login Plain text file _verbs.phtml Aux. Sample output

 Version Control Unique User Downloads Download Rankings  
 100%Total:124All time:7,839
 This week:0This week:1,067Up
 User Comments (1)  
 
very good class
9 months ago (pooya sabramooz)
67%StarStarStarStar