Entity Template

The template for the file used when adding new entities to a web API using the `add entity` command.

Add Entity Template Properties

NameRequiredDescriptionDefault
EntitiesYesA list of entities to create database endpoints.None
AddSwaggerCommentsNoDetermines whether or not Craftsman should scaffold out detailed swagger comments for each endpoint.false

Entity Template Example

An entity template is the same as a standalone as it is for a new boundary with the only difference being the Entities property is at the root level. For example:

Entities:
  - Name: Recipe
    Features:
      - Type: GetList
      - Type: GetRecord
      - Type: AddRecord
      - Type: UpdateRecord
      - Type: DeleteRecord
    Properties:
      - Name: Title
      - Name: Directions