Using JSON editor in OpenAPI builder

You can create or edit the OpenAPI specification (OAS) in the JSON format or in the visual+AI format. The changes that you make in any of the views are reflected in the remaining ones.

In the following GIF, when you edit the property type from Integer to String in the JSON view, the same gets reflected in the Visual+AI view and OpenAPI view.

Editing the specification
Figure 1: Editing the specification in the OpenAPI builder.

Following are the steps to create or edit the OAS in JSON format:

  1. In the OpenAPI builder home page, select any of the following options according to your requirement.
  2. In the editor page, set the JSON view to on.
  3. Type your changes in the OpenAPI specification.
  4. Click Apply changes.

What to do next

After you make the required changes, you can: