The purpose of Orbital is to make it very easy to mock a server capable of responding to requests using a list of endpoints. This reduces the frontend-backend team coupling, allowing teams to work independently.
The designer is an easy-to-use web-based editor which can create mockdefinitions. To create a new mockdefinition, simply import an existing OpenAPI 2.0 or 3.0 definition and the endpoints will be populated in the editor view. Additionally, the mockdefinition can be exported to the server or saved locally. The designer is the recommended way to edit and create mockdefinitions because it validates the scenarios when saving them, preventing common mistakes such as an invalid HTTP status code or a response which is not formatted correctly.
How it works
The designer is an SPA which runs on Angular. When the user loads a mockdefinition, it is stored in the designer store. Multiple mockdefinitions can be imported from the server simultaneously and will be added to the designer store. The mockdefinitions can be switched in the designer, allowing multiple mockdefinitions to be edited in the same workspace.
Creating a new mockdefinition
Creating a new mockdefinition will create a set of default scenarios for all endpoints in the specified OpenAPI spec. These scenarios represent which responses should be returned when the request criteria are met.
Importing from Server
In order to edit mockdefinitions stored on the server, they have to be imported to the designer. When editing is finished, the mockdefinitions can be re-exported to the server so that they can be used to match requests. Additionally, the mockdefinitions can be downloaded locally and can be uploaded or edited later.
Uploading an existing mockdefinition
In order for the server to respond to endpoints, it requires at least one mockdefinition. Uploading a mockdefinition allows the server to respond to endpoints because it has to have the list of endpoints and responses available to respond to the incoming request with.
Downloading a mockdefinition
Downloading mockdefinitions allow you to share them with others, or to save them to use later. Since the server stores all mockdefinitions in an ephemeral in-memory database, all mockdefinitions must be downloaded before shutting down the server, otherwise they will be lost.
Note: when using this feature from the designer, click “Allow this site to download multiple files” warning (or a similar warning) as this is required to download multiple mockdefinitions simultaneously.
Deleting from Server
Mockdefinitions stored in the server can be organized through the designer. A single mockdefinition or multiple mockdefinitions can be deleted from the server through this feature. If you have the same mockdefinitions in your designer, this feature won’t delete them from the designer.
Designer: allows creating mockdefinitions using a web-based UI. These can be exported or imported from the server.
Mockdefinition: contains an OpenAPI spec and a list of scenario(s) for each endpoint in that OpenAPI spec. An OpenAPI spec cannot be used by itself because it does not have the required information to match all incoming requests; the requests could have headers, queries, bodies, and different URL types, including what to respond with. A mockdefinition is an annotated version of the OpenAPI spec.
Endpoint: this is the URL and HTTP method type from the OpenAPI spec.
Scenario: defines which rules the request must match to return a specific response. Each scenario defines one response.