draig-car/examples/petstore/draig.yaml

Database REST API interactive generator CLI and REPL OpenAPI3 based JS generator with interactive ORM/ODM REPL

# API definition file used by all commands or Draig by default
# Change this here if you rename the project file
apiProject: petstore.yaml

# OpenAPI generator name (-g param) to use while generating
# (Default: draig)
openapiGenerator: draig

# Sort method arguments to place required parameters before optional parameters
# (Default: true)
sortParamsByRequiredFlag: true

# Whether to ensure parameter names are unique in an operation
# (rename parameters that are not). (Default: true)
ensureUniqueParams: true

# boolean, toggles whether unicode identifiers are allowed in names or not
# (Default: false)
allowUnicodeIdentifiers: true

# Add form or body parameters to the beginning of the parameter list
# (Default: false)
prependFormOrBodyParameters: false

# TCP port to listen on
serverPort: 3002

# Always generate API tests
apiTests: true
testsClean: true

# Seed database custom configuration using faker
seedGen:
  __useFaker: true
  tags:
    __rows: 9
    name:
    - puppy
    - smart
    - quiet
    - educated
    - playful
    - funny
    - small-sized
    - big-sized
    - regular-sized
  categories:
    __rows: 3
    name:
    - dog
    - cat
    - bird
  pets:
    __rows: 9
    photoUrls: '{{image.animals}}'
    category_id: '{{datatype.number({"min":1, "max":3})}}'
    status: '{{random.arrayElement(["available","pending","sold"])}}'
  orders:
    pet_id: '{{datatype.number({"min":1, "max":9})}}'
    quantity: '{{datatype.number({"min":1, "max":3})}}'
    status: '{{random.arrayElement(["placed","approved","delivered"])}}'

# Database params
dbClient: pg
dbName: petstore
dbHost: localhost
dbUserName: petstore
dbUserPassword: petstore