mulesoft/api-console

A Web Component for an interactive REST console based on RAML files

Antoine Richard

@antoine-richard

Hi. I was looking into these 2 issues : mulesoft/api-console#68 and mulesoft/api-console#87 .
And I'm interrested about this v2

How about this release ?

Is it delayed ?

Damian Martinez Gelabert

@dmartinezg

Hi, @antoine-richard it kind of is, you can see how it is coming along in this branch: https://github.com/mulesoft/api-console/tree/features/v2/src

Antoine Richard

@antoine-richard

Nice.

Do you consider it usable ?

stable enough ?

Damian Martinez Gelabert

@dmartinezg

usable for what? production?

no, not yet

we are a "couple of weeks" away from completion (*disclaimer: we have been a couple of weeks away for some time now)

It is pretty close to completion though.

Antoine Richard

@antoine-richard

Sorry: yes for production.

Ok , thank you

And thank you for your work on this.

We use the console (v1) for a while now and it fits our need

I'll follow the repo activity and preparing myself to switch to v2 when ready. Thank you for your time.

brion-fuller

@brion-fuller

Is this planned to be updated to support RAML 1.0?

Javier

@jcenturion

We are currently spiking to calculate the effort needed. I'll let you know once I have the final estimation.

sameshit

@sameshit

Hello. First of all I want to say thank you that you develop so nice API ecosystem. After Swagger it's really like a sip of fresh air.

I want to ask what options do I have to specify "groups of paths" in the api-console? As far as I understood everything under /resource and below (e.g. /resource/sub-resource) will go into the same group

But /resource/ never grouped with /resource/sub-resource. Does it make sense? What kind of other grouping options I have?

Damian Martinez Gelabert

@dmartinezg

good question, I need to play around to see how it does it

Damian Martinez Gelabert

@dmartinezg

what the console does is:

it groups all resources on the first shortest, complete relative path it finds, the following both do what you expect:

#%RAML 0.8
title: Some API

/foo:
  /bar:
    /baz:
      /bin:

/fee:
/fee/fi:
/fee/fi/fo:
/fee/fi/fofum:

which is to group under /foo and /fee

this also does what is expected:

#%RAML 0.8
title: Some API

/foo:
  /bar:
    /baz:
      /bin:
/foo/bar/baz/bin/bang:

which is group everything under /foo

this is what may be considered tricky:

#%RAML 0.8
title: Some API

/non-root-resource/foo:
  /bar:
    /baz:
      /bin:

groups around /non-root-resource/foo

does this make sense @sameshit ?

Bob Mulder

@bobmulder

Hi Guys, I started using RAML 1.0, and I'm trying to figure out how to use api-console for RAML 1.0. Any hints how to get the good branch via bower?

Vaidas Žilionis

@zilionis

Is possible to reuse example from object examples?

  Child:
    type: object
    properties: 
      id: string
      status: boolean
    examples:
      activeOne:
        id: 2a7f828e-3915-41ba-b336-ead127891113
        status: true
      disabledOne:
        id: 913c4183-3aec-4022-9128-1d443949e9b7
        status: false

  Father:
    type: object
    properties:
      name: string
      childs?: Child[]
    examples: 
      withoutChilds:
        name: EmptyOne
      withChilds:
        name: RichOne
        childs:
          - {id: a, status: false}
          - {id: b, status: true}

instead of writing {id: a, status: false} i whoud like use activeOne for example

Bob Mulder

@bobmulder

Hi all, am I right that on every try-now call a new access_token is requested? Why not saving it and use it next time?

Gian Carlo Val Ebao

@gianebao

i can't make the <raml-console> src work. Everything from grunt worked properly then in the dist folder, i'm trying to load the examples/box.raml but failed.

Josh Gough

@JogoShugh

Hey all, awesome work on the console

I was wondering, is there a way to have the Try It tab show a preview of the URL as it's creating it"

if not, i'm willing to hack on that if it's of interest

Jeff

@jcadow

Hi, Peops - I'm an old programmer who's new to RAML & JavaScript & GitHub. I've found some a few issues and would like some guidance on whether to file bugs for them.

Jeff

@jcadow

Sorry - sent that too soon.

If my api.raml includes an example, UTF-8 encoded, external JSON file containing a text attribute whose value contains an extended character (e.g., lowercase u-umlaut), the request generated when I click the POST button in TryIt seems to use an encoding other than UTF-8, or perhaps it escapes the character by including backslashes. Is there any way to control the encoding that api-console uses when building a request?
If I include HTML table markup in a description attribute's text, multiple blank lines (that were not present in my api.raml file) precede the table in the resulting HTML.
Thanks for your patience with a n00b. Please let me know if you need more detail/examples, and if you think either of these issues is worthy of a bug report.

Gian Carlo Val Ebao

@gianebao

Hi guys! I have an issue with regards to the pattern property in the included schema. It looks like if the regex contains a "|" the whole schema does not appear in the main raml.

Steven Roose

@stevenroose

I have a RAML spec that does not want to load. If I put the file URL, and click load, it flashes a bit but nothing happens, no console error either. If I paste the content, the border gets red, but no error message or console error.

API Console does support RAML v1.0, right?

It's related to a JSON schema that I included. If I leave that out, it works. The schema passes all schema linters that I know of though.

Where communities thrive

People

Repo info

Activity