Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature request] RAML support #968

Closed
janekolszak opened this issue Jul 22, 2015 · 9 comments
Closed

[Feature request] RAML support #968

janekolszak opened this issue Jul 22, 2015 · 9 comments

Comments

@janekolszak
Copy link

RAML (http://raml.org/) - Restful API Modeling Language.

It would be awesome if Revel could extract the API definition from RAML files. It could use it during the project creation or maybe even somehow instead of routes?

@pedromorgan
Copy link
Member

I am 20000% henind this...

Lets GO!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

@pedromorgan
Copy link
Member

To explain more..

Revel is a little baby, and now that the the olde condif format has a few issues..
We want API and configg of configs..

And the nightmare of "configs" for local, dev, p prod.. et all..

So I propose we look at this hard.

Search for issues of Routing and Config..
and what I want is the mother of all configs in revel..
eats anything..
https://github.com/revel/revel/search?utf8=%E2%9C%93&q=+config+yaml&type=Issues

#680

SOO.................

Recently I see RAML, and indeed it sings from my song sheet..

With include files , and externals and all..

Love the idea..

I think we should implement this asap..
the yaml eater, and json eater.. and the false teeth..

@pedromorgan
Copy link
Member

@janekolszak
Copy link
Author

http://raml.org/spec.html

RAML is "RESTful API Modeling", but I guess very small extension to the format could make it useful for routing. I'm no RAML expert though, it may be possible right now.

Asking here: http://forums.raml.org/ would probably help.

@pedromorgan
Copy link
Member

Snag we got is that the "routing in is in .. line format"..

But it worked on some platform which was the start..

Maybe we create a config-crash-mash repos.....
So thro in wll out configs..
and then eat it..
chew it over like..

Its a pinin the ass for me having to kinds manage 3 sets of same
credentials and configs in plases..

I am well into a machine readable format.. that works..
so I can share the db connection on freeflightsim.org..
with
a golang frontend.. in json (coss for internet)

  • but back format was yaml (cos I can add comments
  • then json config for nginx and db
  • and a subdomain in another db..
  • and same app capuring routes et all..

Even redirects in Yamls and a loader for redirect would be cooll..
or rewrites for olde.. php/perl and implemeting end pointz..

On 27 August 2015 at 23:11, Jan Olszak notifications@github.com wrote:

http://raml.org/spec.html

RAML is "RESTful API Modeling", but I guess very small extension to the
format could make it useful for routing. I'm no RAML expert though, it may
be possible right now.


Reply to this email directly or view it on GitHub
#968 (comment).

@gtrevg
Copy link

gtrevg commented Aug 27, 2015

Just a quick comment -- I've been working with RAML for quite a while now and it's been pretty awesome. There's ever growing support for the spec and I see more and more tools using it every day.

There's a number of RAML projects that are doing the same extraction and Server/Client skeleton generation from RAML definitions.

An additional benefit is that, when you are defining your input and output using JSONSchema which RAML fully supports, you could also auto generate the validation code for every endpoint. Here's an example of that that I hacked together one afternoon for a talk: https://github.com/gtrevg/golang-rest-raml-validation . This takes advantage of the fact you can !include json schemas and examples.

Again, so far, using RAML has been pretty awesome. It would be great to have a skeleton framework generated from a RAML spec. That will speed up development tremendously. Additionally, all your documentation will be up to date.

Thanks

@brendensoares
Copy link
Member

RAML looks interesting. I'm all about industry standards that can be supported by many tools. We'll have to prioritize this for release, but there are many other features in front of this.

@brendensoares brendensoares added this to the Backlog milestone Aug 28, 2015
@brendensoares brendensoares added priority-could when we have free time contributor ready and removed status-tested Ready for release labels Aug 28, 2015
@janekolszak
Copy link
Author

This might be usefull after they move to RAML 1.0
https://github.com/EconomistDigitalSolutions/ramlapi

@notzippy
Copy link
Collaborator

Closed, targeted cmd branch revel/cmd#73

@notzippy notzippy added status-wrong-branch and removed status-declined Duplicated, obsolete, or not required labels Mar 13, 2017
@notzippy notzippy mentioned this issue May 31, 2017
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants