RAML – RESTful API modeling language

Re:RAML – RESTful API modeling language by mpdehaan2 on Thursday September 10, 2015 @04:41PM (#10200421)

It might be nice if this was described in an existing data format (YAML, anyone) as a particular form of structure, rather than inventing a new data format.

[ Parent | on HN ]

Re:RAML – RESTful API modeling language by pksunkara on Thursday September 10, 2015 @05:23PM (#10200645)

What do you think about API Blueprint [1]? It is based on Markdown.

[1]: https://apiblueprint.org

[ Parent | on HN ]

Re:RAML – RESTful API modeling language by mpdehaan2 on Tuesday September 15, 2015 @03:35PM (#10222685)

I think Markdown is generally unsuitable as a data format for machines.

YAML strikes a nice balance between machines and people, but I wouldn't want to write a blog post in it.

Markdown is great for blog posts, but APIs are terse.

[ Parent | on HN ]

Re:RAML – RESTful API modeling language by rlevy on Thursday September 10, 2015 @05:24PM (#10200653)

RAML is essentially a YAML with a specific schema. Tell your IDE to treat .raml files as .yaml and all the syntax highlighting, etc will work perfect

[ Parent | on HN ]

Re:RAML – RESTful API modeling language by mpdehaan2 on Tuesday September 15, 2015 @03:36PM (#10222690)

Ah, that makes a lot more sense then.

It appeared to have weirdness from the homepage:

  - secured: !include http://remote-host/secured.yml

/songs:

Which is invalid YAML.

It turns out this is probably an unfortunate word-wrap in the page, where a non-wrapping text field would better convey the format.

[ Parent | on HN ]