Skip to content

Automagical Swagger UI #1

@john-osullivan

Description

@john-osullivan

If we want to really put the cherry on top of all this magic, then we need to take that server generated by Swagger Codegen and boot it up with Swagger UI. Not sure of all the details, but I think that if we hook it up right and there's a running geth instance, we might be able to get a GUI for a smart contract in one command. Proposed syntax is:

abi2api  <path_to_contract_json> <server_output_folder> --extra-magic

It would generate the server output, run that server, run a Swagger UI installation to speak with it, and then open up the browser. Run one command and BAM, you GUI.

We're already generating the server stub and hooking it up with working geth interactions, last step is figuring out how to make Swagger UI pass requests over to that server. Some helpful links:

  • Configuring Swagger UI - Looks like the most important thing is just passing the path to the swagger.yaml, but it isn't clear if it'll auto-detect a real server.
  • Installing Swagger UI - There are two ways to install -- one is meant to be server-side, the other expects to be able to use a bundler in order to pull in additional assets. We want to use the latter, as it results in much less total code. Need to figure out how minimal a bundler we can automagically generate with our API.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions