5/18/2020 PRINT:OAS:Remain API Studio - Remain Software
PRINT:OAS:Remain API Studio
From Remain Software
Welcome to the index of the Remain API Studio. OpenAPI Specification (formerly Swagger Specification) is an API description format for REST APIs. An OpenAPI file allows you to describe your entire API. This editor helps you easily create and edit your OpenAPI file.
Contents
1 Import OpenAPI 2 Export OpenAPI 3 Schemas 3.1 Add New Schema 3.2 Update Schema 3.2.1 Update Schema Name/Description 3.2.2 Update Schema Properties/Attributes 3.3 Delete Schema 3.4 Import Schema 3.5 Extract Schema From JSON Sample/Payload 3.6 Composite Schema 3.6.1 Add Sub-Schema 3.6.2 Change Sub-Schema (composite) Keyword 3.7 Schema Properties 3.8 Additional Properties 4 Paths 4.1 Add Path 4.2 Edit Path 4.3 Delete Path 4.4 Duplicate Path 4.5 Copy|Cut Operation 4.6 Parameters 4.7 Add global parameter 4.8 Add a path/operation parameter 4.9 Edit/Delete parameter 5 Operations 5.1 Add Operation 5.2 Update Operation 5.3 Delete Operation 6 Request Bodies 6.1 Add A Global Request Body 6.2 Add An Operation Request Body 6.3 Add Request Body Content Type 6.4 Delete Request Body Content Type 6.5 Add Schema to Request Body Content Type 6.6 Update Schema to Request Body Content Type 6.7 Delete Request Body 6.8 Update Request Body 7 Responses 7.1 Add new Response 7.2 Delete a Response 7.3 Update Response 7.4 Add new Response Content Type 7.5 Update/Delete Response Content Type 7.6 Update Response Content Type Schema 8 Tags 8.1 Add Global Tag 8.2 Add Operation Tag 8.3 Update Tag 8.4 Delete Tag 8.4.1 Delete Global Tag 8.4.2 Delete Operation Tag 9 Extensions 9.1 Add Extension 9.2 Edit/Delete Extension 10 Authentication and Authorization 10.1 Add Security Scheme 10.2 Delete Security Scheme 10.3 Update Security Scheme 10.4 Add OAuth Flow 10.5 Update OAuth Flow 10.6 Delete OAuth Flow 10.7 Define Global Security 10.8 No Global Security Usage 10.9 Define Operation Security 10.10 Inherit Global Security 10.11 No Security On Operation Level 11 Servers https://remainsoftware.com/wiki/index.php?title=PRINT:OAS:Remain API 1/43 Studio&printable=yes 5/18/2020 PRINT:OAS:Remain API Studio - Remain Software 11.1 Add Server 11.2 Edit Server 11.3 Add Server Variable 11.4 Edit Server Variable 11.5 Overriding Servers 11.5.1 Delete Global Server 11.6 Overview 11.7 Generate Client 11.8 Generate Server 12 Links 12.1 Add Global Link 12.2 Delete Global Link 12.3 Update Global Link 12.4 Add Parameter To Link 12.5 Delete Parameter From Link 12.6 Add Link To Response 12.7 Add Link Reference To Response 13 Examples 13.1 Add Global Example 13.2 Delete Global Example 13.3 Update Global Example
Import OpenAPI
To import an OpenApi file into the editor, click the drop-down menu (top right).
You can import a file from a
Local file-system. To do so, select Import Local OpenAPI from the drop-down menu then pick a file from the files dialog you're prompted with.
Or
Remote location. To do so, select Import Remote OpenAPI from the drop-down menu, fill in the location URL in the location field, then hit Enter or the Read button.
The components of the selected OpenApi file will be shown (e.g., the image below). Select the option that suits you then hit Finish button. You are able to import all or parts of the specification.
https://remainsoftware.com/wiki/index.php?title=PRINT:OAS:Remain API Studio&printable=yes 2/43 5/18/2020 PRINT:OAS:Remain API Studio - Remain Software
Export OpenAPI
To export the currently opened file in the editor, click the export button beside the import button described below, in the local toolbar. By default, you can only export to the local file-system but other systems (like TD/OMS) may extend this functionality.
(https://remainsoftware.com/wiki/index.php/Special:MyLanguage/OAS:O
penAPI_Editor)
Schemas
The Schema Object allows the definition of input and output data types. These types can be objects, but also primitives and arrays.
The schema view (tab) allows you to handle the schemas that reside in the components part of your OpenAPI file.
To manage your OpenAPI schemas, select the Schemas tab at the bottom of the editor:
https://remainsoftware.com/wiki/index.php?title=PRINT:OAS:Remain API Studio&printable=yes 3/43 5/18/2020 PRINT:OAS:Remain API Studio - Remain Software
Add New Schema
You can add a new schema either by clicking the + (plus) button from the toolbar:
or right-clicking the node named Schemas in the view, then selecting New Schema from the popup menu:
Then a wizard appears. Fill in the schema name, type and optionally the description then click Finish. https://remainsoftware.com/wiki/index.php?title=PRINT:OAS:Remain API 4/43
Studio&printable=yes 5/18/2020 PRINT:OAS:Remain API Studio - Remain Software
In that wizard you get also the possibility to specify:
Whether the being created schema is an array of schemas by (un)checking the checkbox named Array of Whether it's of primitive type (e.g., string or integer) or refers yet to an existing schema. Pick a type from the drop-down box right to Array of button The type format from the Format dropdown. (enabled automatically when relevant)
Update Schema
Update Schema Name/Description
To edit a schema name or description. Select a schema then either right-click it then select Edit from the popup menu. Or just click the edit icon from the local toolbar.
https://remainsoftware.com/wiki/index.php?title=PRINT:OAS:Remain API Studio&printable=yes 5/43 5/18/2020 PRINT:OAS:Remain API Studio - Remain Software
Update Schema Properties/Attributes
To do more than a schema's name or/and description edition, please use the views Schema Attributes or/and Components Details. If they're not opened, you can do so using the main toolbar. Choose Windows -> Show View -> Other... then OpenApi.
Both views will react on schema selection. Please note that a schema property (as shown in the middle view above) is in its turn a schema. So you can select a property and update it using Schema Attributes or/and Components Details as well.
Delete Schema
To delete a schema. select the schema to delete then either right-click it then select Delete from the popup menu. Or just click the delete icon from the local toolbar.
Import Schema https://remainsoftware.com/wiki/index.php?title=PRINT:OAS:Remain API 6/43 Studio&printable=yes 5/18/2020 PRINT:OAS:Remain API Studio - Remain Software You can import schema into your openApi file by clicking the import (dorp-down) button from the local toolbar.
Schemas can be imported either from the local file-system or remotely by using a URL:
To import schemas from the local file-system select Import Local Schema, then pick the schemas file from the file dialog you're prompted with. To import remote schemas, fill in the schemas location (e.g., http://example.com/api/some-api.json) then click the Read button or hit enter.
Then select the schemas you want to import then hit Finish.
Extract Schema From JSON Sample/Payload
You can extract a schema definition from an existing JSON sample/payload.
Click the Import icon in the local Schemas toolbar or right-click any schema then select Import From Schema Payload
You're then prompted with a wizard, paste your valid JSON sample and fill in a name for the schema to extract. Then click Finish.
The newly extracted schema definition is visible in the Schemas view. It's added to the schemas under the components section in your API file.
https://remainsoftware.com/wiki/index.php?title=PRINT:OAS:Remain API Studio&printable=yes 7/43 5/18/2020 PRINT:OAS:Remain API Studio - Remain Software
Composite Schema
Add Sub-Schema
The OpenAPI Specification allows combining and extending model definitions, in effect offering model composition.
Example of a composite schema. oneOf in this example takes an array of object definitions. A response payload MAY be described to be exactly one and only one of them:
... components: schemas: Pet: ... oneOf: - $ref: '#/components/schemas/Bird' - $ref: '#/components/schemas/Bunny' - $ref: '#/components/schemas/Cat' ... https://remainsoftware.com/wiki/index.php?title=PRINT:OAS:Remain API Studio&printable=yes 8/43 5/18/2020 PRINT:OAS:Remain API Studio - Remain Software To combine schemas using specs' keywords anyOf, allOf, oneOf or not. That is, add a subschema to an existing schema (making it composite), right-click a schema then select Add Sub-Schema from the popup menu.
Then fill in the wizard you're prompted with. You don't have to fill in the name if you merely want to add an existing schema as subschema (That is, you picked an existing schema as type from the drop-down box beside the Type label).
Please note that if you fill in the name of the subschema you're about to add, then a new schema will always be created, added to the components/schemas section. then added as subschema. This comes handy if you wat to create a new schema then refer it from a composite one in one go.
Then hit Finish.
Change Sub-Schema (composite) Keyword
The relation between a composite schema and its subschemas is specified by these keywords anyOf, allOf, oneOf and not.
To interchange between relations specified by anyOf, allOf, oneOf. Click the composite keyword (as shown below) then select a new relation from the Change To submenu.
Schema Properties https://remainsoftware.com/wiki/index.php?title=PRINT:OAS:Remain API Studio&printable=yes 9/43 5/18/2020 PRINT:OAS:Remain API Studio - Remain Software A schema property is a schema in its turn.
Select a schema to view its properties. Use the local toolbar (as shown above) to add a new property or delete one.
Additional Properties
The value of the additional properties can be boolean or object. Inline or referenced schema MUST be of a Schema Object and not a standard JSON Schema. Consistent with JSON Schema, additional properties defaults to true.
To view and add additional properties, select a schema, then click on the 'Additional Properties' tab.
(https://remainsoftware.com/wiki/index.ph
p/Special:MyLanguage/OAS:Remain API Studio) Paths
This tab helps you manage your OpenAPI paths.
In OpenAPI terms, paths are endpoints (resources), such as /users or /reports/summary/, that your API exposes, and operations are the HTTP methods used to manipulate these paths, such as GET, POST or DELETE.
Add Path
To add a path either select the + button from the local toolbar or right-click the Paths node then select New Path from the popup menu.
https://remainsoftware.com/wiki/index.php?title=PRINT:OAS:Remain API Studio&printable=yes 10/43 5/18/2020 PRINT:OAS:Remain API Studio - Remain Software
Edit Path
To edit a path, select it then click the update button (pen icon) from the local toolbar. Or right-click the path to edit then select Edit from the popup menu.
Delete Path
To delete a path, select it then click the delete button (red icon) from the local toolbar. Or right-click the path to delete then select Delete from the popup menu.
Duplicate Path
Sometimes it's handy to just duplicate a path then edit it instead of creating one from scratch. To do so, select the path you want to duplicate, right-click it then select Duplicate from the popup menu. Or click the duplicate button from the local toolbar.
The content of the path such as operations, parameters, responses and request bodies will also be copied.
Copy|Cut Operation
Right-click the operation you want to copy or cut, then select Cut or Copy. Right-click the destination path then select Paste.
A cut operation can also be performed by dragging the operation and dropping it on the destination path.
https://remainsoftware.com/wiki/index.php?title=PRINT:OAS:Remain API Studio&printable=yes 11/43 5/18/2020 PRINT:OAS:Remain API Studio - Remain Software
Using Drag & Drop:
Parameters
This section describes parameters defined for a path an operation or global. A unique parameter is defined by a combination of a name and location.
Path parameters are defined under a path and inherited by all operations under that path. Operation parameters are defined under an operation Global parameters are defined under parameters in the global components section and are referenced elsewhere via $ref.
Example of a global parameter: ... components: parameters: version: in: path ...
UI-wise, global parameters are always shown when the parameters tab is active:
Add global parameter
To add a global parameter select the tab Global Parameters then click the (+) button in its local toolbar (top right of the view). A new parameter is added. Give it a name, pick a schema and edit the rest of the inputs if necessary.
Local edition links appears when hovering over a parameter UI. Use these links to change a parameters schema (Change Schema) or delete the parameter being hovered over.
Add a path/operation parameter https://remainsoftware.com/wiki/index.php?title=PRINT:OAS:Remain API 12/43 Studio&printable=yes 5/18/2020 PRINT:OAS:Remain API Studio - Remain Software Please not that parameters added to a path are automatically inherited by all that paths operations.
Select the path or operation you want to add a parameter to. Select the tab Parameters (beside Global Parameters). Then click the drop-down button in the local toolbar (top right of the view). Then select New Parameters sub-menu. A new parameter is added. Give it a name, pick a schema and edit the rest of the inputs if necessary.
A parameter being added to a path or operation can be a totally new one, or just reused global one residing in your OpenApi file within the global section which is in Components/parameters. So, to refer to an existing global parameter in your operation, click the drop-down menu and select this time Refer to Global Parameter.
Edit/Delete parameter
You can edit a parameter by using its input fields or the local links that appear when hovering over the parameter UI.
(https://remainsoftware.com/wiki/index.php/Special:My
Language/OAS:Remain API Studio) Operations
For each path, you define operations (HTTP methods) that can be used to access that path. OpenAPI 3.0 supports get, post, put, patch, delete, head, options, and trace. A single path can support multiple operations.
Add Operation
To add an operation, right-click a path then select New Operation.
Fill in the operation wizard you're prompted with, then click Finish
https://remainsoftware.com/wiki/index.php?title=PRINT:OAS:Remain API Studio&printable=yes 13/43 5/18/2020 PRINT:OAS:Remain API Studio - Remain Software
Update Operation
To edit an operation summary or description, open the Components Details view (if not yet opened), then click the operation you want to edit. You can find the Components Details by going to the main toolbar: Windows -> Show View -> Other... then OpenApi.
Delete Operation
You can delete an operation by right-clicking it then selecting Delete from the popup menu.
(https://remainsoftware.com/wiki/index.php/Special:MyLanguage/OAS:Remain API Studio)
Request Bodies
Request bodies are typically used with “create” and “update” operations (POST, PUT, PATCH). For example, when creating a resource using POST or PUT, the request body usually contains the representation of the resource to be created. OpenAPI 3.0 provides the requestBody keyword to describe request bodies.
This editor allows editing global request bodies residing in the components section or those local to an operation.
Add A Global Request Body
To add a global request body, select the tab Global Request Bodies then click the addition button (+) in the local (top-right) toolbar. A new request body with a generated name is added at the bottom of the tab. Update the name and fill in the required fields. Add a content type and define a schema to use within that content as explained in the following sections.
Add An Operation Request Body
Select the operation you want to add the request body to. Then select the operation request body tab.
https://remainsoftware.com/wiki/index.php?title=PRINT:OAS:Remain API Studio&printable=yes 14/43 5/18/2020 PRINT:OAS:Remain API Studio - Remain Software From the top-right local toolbar either click the the addition button (+) to add new request body or the drop-down button to get the ability to refer to an existing request body from the Global Request Bodies tab.
Add Request Body Content Type
To add a content type, Hover over the request body then click the appearing link Add content type.
Delete Request Body Content Type
To delete a content type hover over the content type UI then select the appearing link: Delete content
Add Schema to Request Body Content Type
You can add schema to content type by clicking the link at the bottom of the content type.
Either use an existing schema:
https://remainsoftware.com/wiki/index.php?title=PRINT:OAS:Remain API Studio&printable=yes 15/43 5/18/2020 PRINT:OAS:Remain API Studio - Remain Software
Or create a schema on the fly and use it in this content type. You create an inline schema by letting the name field blank.
If you give the schema being created a name, it'll be also automatically added to the global components/schemas. It's then not an inline schema but referred to, by the content type.
Update Schema to Request Body Content Type
To update the schema within the content type, hover over the content type UI then select the appearing link: Change schema
Delete Request Body https://remainsoftware.com/wiki/index.php?title=PRINT:OAS:Remain API Studio&printable=yes 16/43 5/18/2020 PRINT:OAS:Remain API Studio - Remain Software To delete a request body hover over it then Click the link Delete rquest body
Update Request Body
You can edit the request body by editing its input fields. Hover over it to get the local links that enable to
Add a content type Change a the content type schema Delete a content type from the request body
(https://remainsoftware.com/wiki/index.php/Special:M
yLanguage/OAS:Remain API Studio) Responses
An API specification needs to specify the responses for all API operations. Each operation must have at least one response defined, usually a successful response. A response is defined by its HTTP status code and the data returned in the response body and/or headers
Add new Response
To add a new response either click the addition button in the local toolbar (top-right).
https://remainsoftware.com/wiki/index.php?title=PRINT:OAS:Remain API Studio&printable=yes 17/43 5/18/2020 PRINT:OAS:Remain API Studio - Remain Software
a new response is with an auto-generated status is added where you can edit the fields, content types and schemas.
Delete a Response
To delete a response select the response tab then click the red deletion button in the local toolbar
Update Response
Use the response fields to update it. Hover over of the response to view content type edition link
Add new Response Content Type
Select New Response Content Type from the local toolbar.
Update/Delete Response Content Type
Hover over the content type UI to view editing links.
Update Response Content Type Schema
You can add schema to content type by clicking the link at the bottom of the content type.
https://remainsoftware.com/wiki/index.php?title=PRINT:OAS:Remain API Studio&printable=yes 18/43 5/18/2020 PRINT:OAS:Remain API Studio - Remain Software
Either use an existing schema:
Or create a schema on the fly and use it in this content type. You create an inline schema by letting the name field blank.
If you give the schema being created a name, it'll be also automatically added to the global components/schemas. It's then not an inline schema but referred to, by the content type.
https://remainsoftware.com/wiki/index.php?title=PRINT:OAS:Remain API Studio&printable=yes 19/43 5/18/2020 PRINT:OAS:Remain API Studio - Remain Software
(https://remainsoftware.com/wiki/index.php/Special:MyLanguage/OAS:OpenAPI_
Editor) Tags
You can assign a list of tags to each API operation. Tagged operations may be handled differently by tools and libraries. For example, Swagger UI uses tags to group the displayed operations.
Optionally, you can specify externalDocs for each tag by using the global tags section on the root level. The tag names here should match those used in operations.
The tag order in the global tags section also controls the default sorting in Swagger UI. Note that it is possible to use a tag in an operation even if it is not defined on the root level.
Add Global Tag
Select form page> go to the tags text field under the global section> enter the tag name. Multiple tags can be added using separated comma (,) between the tags.
https://remainsoftware.com/wiki/index.php?title=PRINT:OAS:Remain API Studio&printable=yes 20/43 5/18/2020 PRINT:OAS:Remain API Studio - Remain Software
Add Operation Tag
Select paths page> select an operation from the paths view> select the tags tab> click on the plus button toolbar> tag wizard will start> enter the name of the tag en click on finish
Update Tag
To edit a global tag select form page, then edit the name of the tag from the displayed tags on the text field. Note, be careful with editing comma tags separations.
https://remainsoftware.com/wiki/index.php?title=PRINT:OAS:Remain API Studio&printable=yes 21/43 5/18/2020 PRINT:OAS:Remain API Studio - Remain Software
To edit an operation tag select paths page, then select tags tab. Select a tag to be edited, then on the name text field you can change the name of the tag.
Delete Tag
Delete Global Tag
Go to the global tags text area, delete the tag name that you want to delete. Note, take into account the removal of commas(tags separators).
Delete Operation Tag
https://remainsoftware.com/wiki/index.php?title=PRINT:OAS:Remain API Studio&printable=yes 22/43 5/18/2020 PRINT:OAS:Remain API Studio - Remain Software Select an operation tag from the tag tab and just click the delete icon from the toolbar.
(https://remainsoftware.com/wiki/index.php/Special:MyLanguage/OAS:O
penAPI_Editor) Extensions
Extensions are custom properties that start with x-. They can be used to describe extra functionality that is not covered by the standard OpenAPI Specification.
Add Extension
An extension can be added to the following components:
schema path operation
To add an extension to one of the components, first open the components details view and select the desired component (schema, path or operation) form the editor. Click on the plus icon of the view toolbar, the field wizard will start, enter the name of the field and the type and enter finish.
The added extension will be displayed on the bottom of the view.
Edit/Delete Extension
https://remainsoftware.com/wiki/index.php?title=PRINT:OAS:Remain API Studio&printable=yes 23/43 5/18/2020 PRINT:OAS:Remain API Studio - Remain Software
Authentication and Authorization
This tab helps you manage API authentication and authorization using security schemes. Security can be defined globally then inherited by all operations. An operation can override inherited global security.
Add Security Scheme
To add a security scheme, either select the + button from the local toolbar or right-click the Security Schemes node then select New Security Scheme from the popup menu.
Fill in the security name and type in the wizard then hit Finish
https://remainsoftware.com/wiki/index.php?title=PRINT:OAS:Remain API Studio&printable=yes 24/43 5/18/2020 PRINT:OAS:Remain API Studio - Remain Software
The newly created security scheme appears in the left and its content in the right editor.
Delete Security Scheme
Select the security scheme you want to delete then click the X button from the local toolbar. Or right-click the scheme to delete then select Delete from the popup menu.
Update Security Scheme https://remainsoftware.com/wiki/index.php?title=PRINT:OAS:Remain API Studio&printable=yes 25/43 5/18/2020 PRINT:OAS:Remain API Studio - Remain Software Select the security scheme to update. Its content shows up in the right-side editor where you can update it.
Add OAuth Flow
To add an OAuth flow, right click the OAuth security scheme or Flows node (under the security scheme if it already has one), then select New Flow from the popup menu.
Select a flow type in the wizard then hit Finish;
The newly created flow appears selected in the left side and its content in the right-side editor where you can proceed editing.
Update OAuth Flow
Select the OAuth flow to update. Its content which depends on the flow type shows up in the right-side editor where you can update it. The editor also allows you to add/update/remove flow scopes.
https://remainsoftware.com/wiki/index.php?title=PRINT:OAS:Remain API Studio&printable=yes 26/43 5/18/2020 PRINT:OAS:Remain API Studio - Remain Software
Delete OAuth Flow
Select the OAuth flow you want to delete then click the X button from the local toolbar. Or right-click the OAuth flow to delete then select Delete from the popup menu.
Define Global Security
Security may be defined globally. That is, on API level and will apply to all operations/calls. Security can be overridden on operation level (https://remainsoftware.com/wik i/index.php/OAS:Remain API Studio/Security/Define_Operation_Operation) , though.
To define security globally, select the bottom Security tab, then select the tab titled: Define Global Security
https://remainsoftware.com/wiki/index.php?title=PRINT:OAS:OpenAPI_Editor&printable=yes 27/43 5/18/2020 PRINT:OAS:Remain API Studio - Remain Software
If you want to you use, in one go, all available security schemes in your global security, check then the check-box beside the root Security Requirements. Uncheck it if you want to use no security at all on global level.
Otherwise to select-add a security scheme, right-click the root node Security Requirements, then Add Security Scheme (OR) then select the scheme you want.
Note: All security schemes on root level (Security Requirements) are logically OR-ed when evaluated.
If a security scheme has scopes, then check/uncheck the box beside each scope to add/remove it
To group a security scheme with another one making a list of them, right-click a security scheme, then select from the AND menu the scheme to add.
Note: All security schemes within a list/group are logically AND-ed when evaluated.
https://remainsoftware.com/wiki/index.php?title=PRINT:OAS:Remain API Studio&printable=yes 28/43 5/18/2020 PRINT:OAS:Remain API Studio - Remain Software
No Global Security Usage
You can opt for not defining any global security at all. Operations may still have their own security defined locally (https://remainsoftware.com/wiki/index.php/OAS:OpenA PI_Editor/Security/Define_Operation_Operation).
To disable any global security, uncheck the box next the the root node: Security Requirements
Define Operation Security
You can override global security (https://remainsoftware.com/wiki/index.php/OAS:Remain API Studio/Security/Define_Global_Security) on operation level. To do so, go to the Paths tab (at the bottom) then select the operation you want. Select the Security tab where you can define security on the selected operation level.
https://remainsoftware.com/wiki/index.php?title=PRINT:OAS:OpenAPI_Editor&printable=yes 29/43 5/18/2020 PRINT:OAS:Remain API Studio - Remain Software
If you want to you use, in one go, all available security schemes in your global security, check then the check-box beside the root Security Requirements. Or uncheck it so that no security will be used on this operation level.
Note: All security schemes on root level (Security Requirements) are logically OR-ed when evaluated.
If a security scheme has scopes, then check/uncheck the box beside each scope to add/remove it
To group a security scheme with another one making a list of them, right-click a security scheme (not the root), then select from the AND menu the scheme to add.
Note: All security schemes within a list/group are logically AND-ed when evaluated.
Inherit Global Security
Globally defined security is inherited automatically by all operations unless overridden by individual operations. An operation may choose to use less, more or no security at all.
If you want to restore an operation security back to default global security. Then, select the operation from the left view, right click the root node: Security Requirements (in the right editor) and select Inherit Global Security from the pop-up menu.
https://remainsoftware.com/wiki/index.php?title=PRINT:OAS:Remain API Studio&printable=yes 30/43 5/18/2020 PRINT:OAS:Remain API Studio - Remain Software
No Security On Operation Level
An operation may opt for not using any security at at all by overriding the globally defined security.
Select the operation from the left view, right-click the root node: Security Requirements (in the right editor) and select Don't Use Any Security from the pop-up menu.
(https://remainsoft
ware.com/wiki/index.php/Special:MyLanguage/OAS:Remain API Studio)
Servers
Add Server
To add a server, either select the + button from the local toolbar or right-click the Servers node then select New Server from the popup menu.
Fill in the server URL and the description then hit Finish
https://remainsoftware.com/wiki/index.php?title=PRINT:OAS:OpenAPI_Editor&printable=yes 31/43 5/18/2020 PRINT:OAS:Remain API Studio - Remain Software
The newly created server appears in the left and its content in the right editor.
Edit Server
To edit a server, select a server node and mouse right-click then select Edit from the popup menu.
https://remainsoftware.com/wiki/index.php?title=PRINT:OAS:Remain API Studio&printable=yes 32/43 5/18/2020 PRINT:OAS:Remain API Studio - Remain Software
Add Server Variable
To add a server variable, select a sever node and mouse right-click then select New Variable from the popup menu.
Fill in the server variable name and the default value then hit Finish
https://remainsoftware.com/wiki/index.php?title=PRINT:OAS:Remain API Studio&printable=yes 33/43 5/18/2020 PRINT:OAS:Remain API Studio - Remain Software
The newly created server variabl appears in the left and its content in the right editor.
Edit Server Variable
To edit a server variable, select a server variable node and mouse right-click then select Edit from the popup menu.
https://remainsoftware.com/wiki/index.php?title=PRINT:OAS:Remain API Studio&printable=yes 34/43 5/18/2020 PRINT:OAS:Remain API Studio - Remain Software
Overriding Servers
The global servers array can be overridden on the path level or operation level. This is handy if some endpoints use a different server or base path than the rest of the API.
To override a global server, select path or operation node and in the appropriate servers tab click on + button or Override global servers link, then the wizard with global servers will be displayed, select a sever and hit Finish.
Delete Global Server
To delete a server, select the server to be deleted and click on X button from the local toolbar or right-click the server node then select delete from the popup menu.
https://remainsoftware.com/wiki/index.php?title=PRINT:OAS:Remain API Studio&printable=yes 35/43 5/18/2020 PRINT:OAS:Remain API Studio - Remain Software
(https://remainsoftware.com/wiki/index.php/Special:MyLanguage/OAS:
Remain API Studio)
Overview
OpenAPI Generator allows generation of API client libraries and server stubs. Currently, the following languages/frameworks are supported:
API clients:
ActionScript, Ada, Apex, Bash, C, C# (.net 2.0, 3.5 or later, .NET Standard 1.3 - 2.0, .NET Core 2.0), C++ (cpp-restsdk, Qt5, Tizen), Clojure, Dart (1.x, 2.x), Elixir, Elm, Eiffel, Erlang, Go, Groovy, Haskell :(http-client, Servant), Java (Jersey1.x, Jersey2.x, OkHttp, Retrofit1.x, Retrofit2.x, Feign, RestTemplate, RESTEasy, Vertx, Google API Client Library for Java, Rest-assured, Spring 5 Web Client, MicroProfile Rest :Client), Kotlin, Lua, Nim, Node.js/JavaScript (ES5, ES6, AngularJS with Google Closure Compiler annotations, Flow types), Objective-C, OCaml, Perl, PHP, PowerShell, Python, R, Ruby, Rust (rust, rust-server), Scala :(akka, http4s, scalaz, swagger-async-httpclient), Swift (2.x, 3.x, 4.x, 5.x), Typescript (AngularJS, Angular (2.x - 8.x), Aurelia, Axios, Fetch, Inversify, jQuery, Node, Rxjs)
Server stubs:
Ada, C# (ASP.NET Core, NancyFx), C++ (Pistache, Restbed, Qt5 QHTTPEngine), Erlang, F# (Giraffe), Go (net/http, Gin), Haskell (Servant), Java (MSF4J, Spring, Undertow, JAX-RS: CDI, CXF,Jersey, RestEasy, :Play Framework, PKMST, Vert.x), Kotlin (Spring Boot, Ktor, Vertx), PHP (Laravel, Lumen, Slim, Silex, Symfony, Zend Expressive), Python (Flask), NodeJS, Ruby (Sinatra, Rails5), Rust (rust-server), Scala (Finch, :Lagom, Play, Scalatra)
Generate Client
To generate a client code, click on the Generate client header button, then select the client language.
https://remainsoftware.com/wiki/index.php?title=PRINT:OAS:OpenAPI_Editor&printable=yes 36/43 5/18/2020 PRINT:OAS:Remain API Studio - Remain Software
The generated code will be displayed on the directory 'Generated' under Remain Remain API Studio project.
Generate Server
To generate a server, click on the Generate Server header button, then select the server language.
https://remainsoftware.com/wiki/index.php?title=PRINT:OAS:Remain API Studio&printable=yes 37/43 5/18/2020 PRINT:OAS:Remain API Studio - Remain Software
The server code will be generated on the Generated directory under Remain openAPI project.
Links
Add Global Link
Links helps you describe how various values returned by one operation can be used as input for other operations. This way, links provide a known relationship and traversal mechanism between the operations.
To add a global link, select the Links tab, then the + button in the top-right of the editor.
https://remainsoftware.com/wiki/index.php?title=PRINT:OAS:Remain API Studio&printable=yes 38/43 5/18/2020 PRINT:OAS:Remain API Studio - Remain Software
Delete Global Link
To delete a global link, select the Links tab, then the Delete button within the link you want to delete.
Update Global Link
A global link can be updated by directly changing the content of any of its input fields.
Add Parameter To Link
To add a parameter to a global link, select the Links tab, then the Add Parameter link in the top-right of the editor.
https://remainsoftware.com/wiki/index.php?title=PRINT:OAS:Remain API Studio&printable=yes 39/43 5/18/2020 PRINT:OAS:Remain API Studio - Remain Software
Delete Parameter From Link
To delete a parameter from a global link, click the red X delete button beside the parameter.
Add Link To Response
A link is meant to be used by responses. A response can either use a new link or refer to an existing global one (https://remainsoftware.com/wiki/index.php?title=OAS:Open API_Editor/Links/Add_Link_Reference_To_Response)
To use a new link for a response, click the top-right menu within the response editor, then select New Link. A new link UI appears within the group Links at the bottom of the response.
https://remainsoftware.com/wiki/index.php?title=PRINT:OAS:Remain API Studio&printable=yes 40/43 5/18/2020 PRINT:OAS:Remain API Studio - Remain Software
Add Link Reference To Response
A link is meant to be used by responses. A response can either use a new link (https://remainsoftware.com/wiki/index.php/OAS:Remain API Studio/Links/ Add_Link_To_Resp onse) or refer to an existing global one.
To refer to an existing global link within a response, click the top-right menu within the response editor, then select Refer to Global Link.
From the prompting dialog, select the link to refer to then hit Finish.
A new link UI appears within the group Links at the bottom of the response contaning the newly added link reference.
https://remainsoftware.com/wiki/index.php?title=PRINT:OAS:OpenAPI_Editor&printable=yes 41/43 5/18/2020 PRINT:OAS:Remain API Studio - Remain Software
Examples
Add Global Example
You can add examples to parameters, properties and objects to make OpenAPI specification of your web service clearer.
To add a global example, select the Examples tab, then the + button in the top-right of the editor.
Delete Global Example
To delete a global example, select the Examples tab, then the Delete example button within the example you want to delete.
https://remainsoftware.com/wiki/index.php?title=PRINT:OAS:Remain API Studio&printable=yes 42/43 5/18/2020 PRINT:OAS:Remain API Studio - Remain Software
Update Global Example
A global example can be updated by directly changing the content of any of its input fields.
Retrieved from "https://remainsoftware.com/wiki/index.php?title=PRINT:OAS:Remain API Studio&oldid=77622"
This page was last modified on 4 March 2019, at 14:01.
https://remainsoftware.com/wiki/index.php?title=PRINT:OAS:OpenAPI_Editor&printable=yes 43/43