Coder Social home page Coder Social logo

Add support for Swagger UI about jarvis HOT 2 OPEN

dyalog avatar dyalog commented on July 29, 2024
Add support for Swagger UI

from jarvis.

Comments (2)

rikedyp avatar rikedyp commented on July 29, 2024

Hi Gheorghe,

We'd like to better understand what you envision with Jarvis and SwaggerUI. From what we can tell, it seems the steps are:
• Define an API using OpenAPI in a json or yaml file.
• Make it viewable using SwaggerUI as a set of HTML/CSS/JavaScript files.
• Enable Jarvis to serve that content up through its HTML interface.
It would still be up to the developer to write all the code in Jarvis to actually service the requests.

Is that along the lines of what you were envisioning? Or did you have something else in mind?

If that's what you had envisioned, then I think we just need to enable the HTML interface in REST mode. In fact, it wouldn't matter whether the content was generated by SwaggerUI or any other tool as Jarvis doesn't need any special knowledge of the source of the HTML/CSS/JS.

from jarvis.

GheorgheBalan89 avatar GheorgheBalan89 commented on July 29, 2024

I think that would definitely be a possible solution.
The outcome would be to use the SwaggerUI interface as a test tool while developing an APL based webservice in Jarvis.

  • as a developer I would expect to write all the code pertaining to the request/response cycle
  • the swagger interface would update dynamically as I make changes to the signature of an endpoint exposed via swagger
  • ideally there would be a simple way to toggle the swagger interface depending on the type of environment the api is running in (it should never be turned on in a production environment) - it could be achieved via an environment variable or via a config file.

Overall I think we are aligned about the outcome - but do let me know if anything is unclear.

from jarvis.

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.