Git Product home page Git Product logo

Comments (9)

dmartinezg avatar dmartinezg commented on August 23, 2024

hi @danielb2 that is a CORS issue, you can check my explanation here and test that CORS is disabled here

As for your second question, the parameter name is raml: http://raml.herokuapp.com/?raml=https://raw.githubusercontent.com/kevinrenskers/raml2html/master/example.raml

from api-console.

danielb2 avatar danielb2 commented on August 23, 2024

Hm, maybe the error message could be a bit nicer at least?

from api-console.

dmartinezg avatar dmartinezg commented on August 23, 2024

What? You mean check that the server is up and that CORS is enabled is not clear enough? 😉

Actually, the api-console project is really the <raml-console with-root-documentation></raml-console> directive.

index.html is a sample implementation of how you can embed it in an application, it is not meant to be used as a debugging/designing environment, thats what the designer is for, or as a hosting environment, you should write that one.

The URL and the RAML fields were put in there to help in developing the console itself.

from api-console.

danielb2 avatar danielb2 commented on August 23, 2024

Well, frankly when I first look at RAML I dismissed it because the main point of value for me was no tool to actually make documentation for me, which is, for me, the project's biggest charm. How else do you share the design? The spec is too noisy just for someone to easily look at and understand it. It requires effort.

The project has come a long way since, and I thought this tool was going to be perfect to share design with. But, it's too clunky to ask someone to copy and paste code into it only to have it not persist. All it really needs is a way to save state so it can be shared. The other alternative, the one I assumed would be the first to be ready, html generation, isn't completely done either. So I've made two commits on code this weekend to help it along.

And if I didn't bore you with all that. The message, while clear when read, is such a jumble and not presented in an expected fashion, that I wasn't sure if it was even expected. If it were just styled up and didn't look like something which didn't even belong there, then I probably, while still undesired, be more inclined to believe it. I still don't want to believe it. This is an awesome tool when it actually works. I think all of this is fantastic. Just has a little further to go before it's going to so way much more awesome.

from api-console.

clonq avatar clonq commented on August 23, 2024

Feeding the console from the url e.g. ?raml=/examples/simple.raml seems to be very slow. I takes over 5 seconds on my machine before anything shows up. Is that a known issue?

from api-console.

jcenturion avatar jcenturion commented on August 23, 2024

@clonq: Are you using the latest version? which browser? version?

Thanks in advance.

from api-console.

jarrodek avatar jarrodek commented on August 23, 2024

API Console version 3 is no longer supported. We are at version 6 right now.
Please, upgrade your version of the console to have latest updates.

from api-console.

danielb2 avatar danielb2 commented on August 23, 2024

When I filed the ticket 6 (!!!) years ago, version 6 wasn't available 😉

from api-console.

jarrodek avatar jarrodek commented on August 23, 2024

I know. I wasn't working on this project either :) I am cleaning up stale issues. Apologies.

from api-console.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.