search

mulesoft / api-designer

A web editor for creating and sharing RAML API specifications
Other
1.07k stars 266 forks source link

Request/response schema/example #236

Closed ghost closed 8 years ago

ghost commented 10 years ago

Hi,

currently, RAML defines both an example and a schema for a request and response. While I understand that the example is (and should be) just an XML or a JSON which is displayed by the designer/console as code, are there any plans to display the schema a bit differently? AFAIU a schema contains the information about the fields, its data types and it's constraints (max/min values, enum values, etc.). It would be very nice, if the schema would be displayed as kind of a table with the field name, the field type, whether it is required or not, the description, etc. This is was I frequently use when coding against an API to lookup the fields and its allowed values.

Tobias.

usarid commented 10 years ago

Did you mean something like https://github.com/lbovet/docson (and see this example http://lbovet.github.io/docson/index.html#/docson/examples/example.json) -- one of our users has gotten pretty enthusiastic about embedding it into the new API Console we're rolling out soon. It's for JSON< not XML, though.

sichvoge commented 9 years ago

@usarid do you know where we are w/ that? it's more related to the api console, therefore i might create a new issue there as a proposal for a new feature. It's pretty cool, therefore I would love to have that in.

usarid commented 9 years ago

Nothing to say from my side at this point, other than that I agree that schema in general could benefit from a lot of UX love

sichvoge commented 9 years ago

@dmartinezg, @alejandroschenzle & @blakeembrey what do you guys think of the docson project? shouldn't be to hard to integrate :P

robertlevy commented 9 years ago

docson looks like it makes a lot of assumptions about how to load files. would be great to see this type of UX integrated but it probably needs a refactoring first

Date: Wed, 17 Jun 2015 11:40:59 -0700 From: notifications@github.com To: api-designer@noreply.github.com Subject: Re: [api-designer] Request/response schema/example (#236)

@dmartinezg, @alejandroschenzle & @blakeembrey what do you guys think of the docson project? shouldn't be to hard to integrate :P

— Reply to this email directly or view it on GitHub.

sichvoge commented 9 years ago

@robertlevy refactoring the designer or docson?

robertlevy commented 9 years ago

Refactoring docson so it can pull from an abstract storage system (like the designer already does)

On Jun 17, 2015, at 5:34 PM, Christian Vogel notifications@github.com wrote:

@robertlevy refactoring the designer or docson?

— Reply to this email directly or view it on GitHub.

sichvoge commented 9 years ago

Do you think it makes sense to contact him, or do you think it make sense to fork and work on that?

sichvoge commented 8 years ago

This is related to https://github.com/mulesoft/api-console/issues/82. Closing it here since that is more related to the console.