API Simulation

API Simulation is a feature that allows you to simulate the behavior of an API. This is useful for testing, demonstration, and development. It decouples the interface implementation from the interface users. The simulation is based on olink protocol, you need your application to use Object Link version of implementation to be able to receive the simulation data. Check your templates for olink feature for more information. See simulation documentation for more info.

Beta

The simulation server is in beta and will gain new and improved functionality soon.

Quick API Simulation

API Simulation is a feature of the ApiGear platform. It allows to simulate the behavior of an API. The apigear command line tool can be used to simulate an API. The following example shows how to simulate the demo API.

API simulation is based on a simulation scenario. The following example shows how to create a simulation scenario for the demo API used for code generation example.

# demo.scenario.yaml
schema: apigear.scenario/1.0
name: "demo scenario"
version: "1.0"
interfaces:
  - name: demo.Counter
    properties:
      count: 0
    operations:
      - name: increment
        actions:
          - $set: { count: 1 }
      - name: decrement
        actions:
          - $set: { count: 0 }

Now we can run the simulation server using the following command. This scenario does not include sequences. It simulates the operations on interface and provides initial state for properties. For steps simulation see scenario documentation.

apigear simulate run demo.scenario.yaml

It will load the simulation scenario from the demo.scenario.yaml file. The simulation server will listen for API calls. The simulation server by default is "127.0.0.1:4333". To change the address use the --addr option.
The example simulates a server side and normally the API calls will come from a running API client.