User Interface

Document Listing Interface

  • Document Listing Header contains the actions and inputs related to the Document Listing section below.
  • Document Listing contains a list of documents that have been imported, or created.

Design Mode Interface

  • Document Header contains document navigation, document mode switch, and actions related to the mode displayed.
  • Design Sidebar contains navigation elements and configuration elements related to the current mode and current design document.
  • Design Code Editor is a fully featured code-editor showing the file contents of the specification.
  • Design Linter Panel is a toggleable panel that displays all linter errors and warnings relating to the editor content.
  • Document Preview is a toggleable pane that displays a rendered version of the specification being designed.

Debug Mode Interface

  • Document Header contains document navigation, document mode switch, and actions related to the mode displayed.
  • Debug Sidebar contains navigation elements and configuration elements related to the current design document.
  • Debug Request Panel contains all necessary elements to build or modify requests to be made against your API.
  • Debug Response Panel displays response information received from the request made against your API.
Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.

Still need help? Contact Us Contact Us