SHARE THIS ARTICLE

Overview

APIMatic’s API Editor rids you of the pain of writing your API descriptions in boring text editors. It enables to you describe your APIs and personalize your SDKs using a beautiful GUI. We guide you at each step with contextual documentation and help you get those SDKs out to your users without breaking a sweat.

Screenshot

The editor consists of three main panels.

  1. Navigation (left)
  2. The editor (center)
  3. Contextual help (right)

The navigator on the left side of the API editor allows you to easily navigate to different sections of your API description. It contains a search bar which takes you to the part of the description you’re looking for. There are four main navigation buttons at the top.

Sidebar-top

  • The first button takes you to the home page of the APIMatic website.
  • The second button takes you to the My APIs page.
  • The third button is used for generating an SDK. Clicking on it will bring up a popup-menu from which further options can be selected for SDK generation.
  • The fourth button is used for validating an API description.

The navigator divides your API description into four simple categories.

Sidebar

Settings

Edit basic settings and define authentication, code generation and test generation settings for your API. You can also view information about global API errors for your API.

Endpoints

Naviagate to and edit individual endpoints specified in your API description. Similar endpoints can be grouped together allowing you to aggregate endpoint code in files in the generate SDKs. The APIMatic editor also allows you to import an Endpoint using a curl command.

Models

Naviagate to and edit individual models specified in your API description.

Test Cases

Create, view and edit all the test cases for your endpoints.

The Editor

Lets you make changes to a certain portion of your API description.

Sidebar

Contextual Help

Displays contextual documentation depending on the position of your mouse cursor.

Sidebar


Have questions? Submit a request.