Aida

Aida

  • Docs
  • Reference
  • Contributors

›Reference

Getting Started

  • Introduction
  • Installation
  • Creating Your First Model
  • Enriching Your Model
  • Introduction to Injectors
  • Introduction to Consumers

Advanced Usage

  • Introduction to Endpoints
  • Chaining Injectors
  • Putting It All Together

Extending Aida

  • Creating A Custom Injector

Reference

  • Defined Types
  • Data Model
  • Endpoints Model
  • Existing Injectors
  • Existing Consumers
  • Aida Config
  • Faked Data

Data Model

Each property of the data model can be a primitive or a composite. A composite is either an object or an array of primitives and/or composites. A primitive is marked as one by having a vtype property, holding one of the defined primitive types.

Primitive

{
  vtype: 'int64',
}

Composite (Object)

{
  name: {
    vtype: 'int64',
  }
}

Composite (Array)

[
  {
    vtype: 'int64',
  }
]

Common Properties

Aside from the vtype property, other properties will depend almost entirely by what each injector needs. However, it is practical to have some properties standardized which can be used by multiple injectors. So far, the following properties are recommended to be used:

  • description - Textual description of the primitive.
  • required - Boolean, denotes whether a primitive is required.
  • faker - Specifies the faker name, array, or options object for generating fake values for that primitive, as described here.
← Defined TypesEndpoints Model →
  • Primitive
  • Composite (Object)
  • Composite (Array)
  • Common Properties
Aida
Docs
Getting StartedReference
Community
Project Chat
More
GitHubStar
Copyright © 2018 Stevche Radevski