Skip to main content

Schema

A schema defines the format of the request and response data. It uses the TypeSchema specification. The following example shows a simple object.

Configuration​

schema_update

Name​

The name of the schema.

Schema​

A TypeSchema which describes the JSON structure.

Example​

{
  "definitions": {
    "Student": {
      "type": "object",
      "properties": {
        "firstName": {
          "type": "string"
        },
        "lastName": {
          "type": "string"
        },
        "age": {
          "type": "integer"
        }
      }
    }
  },
  "root": "Student"
}

Designer​

Through the schema designer it is possible to use a visual editor to design a schema. This helps in case you are new to TypeSchema and don't know the exact format.

designer