Welcome to RAMLfications’s documentation!¶
Release v0.1.5 (What’s new?).
ramlfications is an Apache 2.0-licensed reference implementation of a
RAML parser in Python intended to be used for parsing API definitions
(e.g. for static documentation-generation).
If you’ve never heard of RAML, you’re missing out:
RESTful API Modeling Language (RAML) is a simple and succinct way of describing practically-RESTful APIs. It encourages reuse, enables discovery and pattern-sharing, and aims for merit-based emergence of best practices. The goal is to help our current API ecosystem by solving immediate problems and then encourage ever-better API patterns. RAML is built on broadly-used standards such as YAML and JSON and is a non-proprietary, vendor-neutral open spec.
ramlfications and not pyraml-parser?¶
I chose to write a new library rather than wrestle with pyraml-parser as it was not developer-friendly to extend (in my PoV, others may have more success) and did not include required RAML features (e.g. uriParameters, parsing of security schemes, etc), as well as a lot of meta programming that is just simply over my head. However, I do encourage you to check out pyraml-parser! You may find it easier to work with than I did.
- Requirements and Installation
- Extended Usage
- API Definition