Visual designer
API Studio > Design > Designer has two views of the same document: Code and Visual. A change in one view shows in the other. Save stores the document in the format chosen above the editor.
Open the visual designer
- Open the API and select a draft version.
- Open API Studio > Design > Designer.
- Choose Visual.
Visual opens only when the code parses. Fix a parse error in Code first. Selecting a problem in the Problems panel returns to Code at that place.
Text fields apply when you leave the field or press Enter.
API details
Title is required. Version and Description are optional.
Operations
Add an operation with New method and New path, such as GET and /orders/{id}. Each
operation has:
- Method, Path, Summary and Operation ID
- Parameters: Name, In (path, query or header), Type and Required. A path parameter is always required.
- Request body: Media type, Schema and Required
- Responses: one per status code, with Description, Media type, Schema and Example
The designer shows a problem beside its field, for example:
- two operations with the same Operation ID
- a path parameter that is not in the Path
- a status code that is not a valid HTTP status
- an empty name
Security schemes
Add a scheme with New scheme name, then choose its Type:
| Type | Fields |
|---|---|
| API key | Parameter name and In (query, header or cookie) |
| HTTP | Scheme, such as bearer, and Bearer format |
| OAuth 2.0 | Token URL for the client credentials flow |
| OpenID Connect | OpenID Connect URL |
Schemas
Add a schema with New schema name. Add properties with New property name. Each property has Name, Type, Format, Allowed values and Required.
Renaming a schema updates every operation that refers to it.
Published versions
A published version opens read only in both views. To change it, press New draft on the API. See Publishing and versions.