Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
branch: master
Fetching contributors…

Cannot retrieve contributors at this time

file 31 lines (22 sloc) 1.496 kb

I/O Doctor

You can now use I/O Doctor as a hosted application via iodoctor.net.

I/O Doctor is a GUI for creating and editing JSON config files that are used with I/O Docs, an interactive API documentation system from Mashery.

Description

How It Works

Select an existing I/O Docs config to upload, or create a new config and start adding Endpoints, Methods, and Parameters. When an existing config is used, it is parsed and forms for editing each Endpoint, Method, and Parameter will be created.

Click an item from the menu on the left to begin editing. View the JSON output at any time by hitting the "output" tab. When finished, click "Save File" to download the JSON file. I/O Doctor does not store any data. Make sure you save your JSON output.

Technology

I/O Doctor is built on Sinatra, Twitter Bootstrap 2.0, and jQuery, and uses form2js for structured, hierarchical HTML form data.

TODO

  • Refactor to use a Javascript MVC framework
  • Highlight selected Endpoint in the menu
  • Wire up the Method links in the menu
  • Add validation on form fields
  • Ability to reorder nodes
  • Ability to edit JSON directly on output tab - GUI v Source view
  • Ability to copy a node
  • Add Parameter buttons both above and below the list of parameters
  • Default the paramater data type to be custom: string
Something went wrong with that request. Please try again.