focisolutions/orbitaldesigner repository overview

⁠What is Orbital?

Orbital is an HTTP mocking framework that enables teams to achieve rapid software development and testing. Orbital supports mocking services by only providing their OpenAPI Specifications files in either YAML or JSON format. The framework is composed of two entities: the Orbital Designer and the Orbital Server. The Designer is a web-based workspace that allows for quick creation and modification of mock scenarios using the desired OpenAPI Specification file. The Designer can be used to export the mock service scenarios to the Server. Besides accepting and storing service mock definitions the Server is capable of of intercepting HTTP requests and response with the best response possible based on the saved mocked service scenarios. The Server also has reserved Admin endpoints to provide the ability to add, edit, delete mock definition files.

⁠Why should you use Orbital?

Orbital allows for parallel development between front-end and back-end teams by reducing the dependency of the front-end on the back-end.

Normally, creating a back-end API takes many days, if not weeks. During this time, front-end developers have changing API contracts, and have to develop against a moving target.

⁠Features

• GUI Editor: an easy-to-use web-editor that allows developers to create mocks in minutes
• Export to Server: directly export your mocks to Orbital Server
• OpenAPI compliant: mocks are created using the OpenAPI v2.0 specification
• Pipeline: each API filter is isolated, allowing for greater security, and better error and load handling
• Easy to deploy: just two docker containers, and only two commands to run

⁠Getting Started

Note: Orbital uses an in-memory datastore. Please save or export all data (via Export to JSON or Export to Server) before exiting, otherwise it will be lost.

It's very easy to get started; just download the Docker Engine for Linux, Mac, and Windows⁠:

⁠Using Docker

docker run -p 4200:80 focisolutions/orbitaldesigner

docker run -p 5001:80 focisolutions/orbitalmock

The mock definition designer will be running on http://localhost:4200, and the server on http://localhost:5001.