Remain OpenAPI Studio Benefits and Features

Simple steps, in the order that makes sense to you:

The first step to designing your API is to define it. Then the other tabs can be used in whichever sequence fits your needs:

• Security 
• Servers
• Schemas
• Paths

The slideshow will take you through each step of the process. Additionally you can import and export definitions; this capability is located on the main definition tab and the Schema tab.

A logical start made intuitive:

Within the General Info tab, you will define your API, including contact information and version information. In addition you can:

• Convert Swagger to OpenAPI Specifications.
• Import and export OpenAPI definitions.
• Generate Client/Server code.

Fully implemented OAS server specifications:

Multiple servers are not a problem. And you can use them to specify one or more base URLs for your API.

To add a server, either select the + button from the local toolbar, or right-click the Servers node and then select New Server from the pop-up menu.

Define and manage API paths and how you operate them:

This tab helps you manage your API paths.

In API terms, paths are endpoints (resources), such as /users or /reports/summary/, that your API exposes, and the operations are HTTP methods used to manipulate these paths, such as GET, POST or DELETE.

Logical management of your schemas:

The Schema Object tab manages the definition of input and output data types. These types can be objects, but also primitives and arrays.

The Schemas tab allows you to handle the schemas that reside in the components part of your API specification.

Fully implemented OAS security specifications:

This tab helps you design, describe and manage "protected" API authentication and authorization security schemes as specified by OAS.

Security can be defined globally, then inherited by all operations. An operation can override inherited global security.

Import an API spec:

With our Import function you can click and select from the drop-down menu (top right) to import an OpenApi spec-compliant file into the Studio. Use the the drop-down menu to choose an import type, and a wizard will guide you through the import. 

The three import options are:

• Import from Schema Payload.

• Import Local Schema.

• Import Remote Schema.

Direct export functionality between your API definition and local file system:

To export the currently opened file in the editor, click the import/export button shown here in the local toolbar and select Export OpenAPI to File. By default, you can only export to the local file-system.  The export function is available on the General Info tab.