TypeSchema

TypeSchema is a JSON format to describe data models in a language neutral format. A TypeSchema can be easily transformed into specific code for almost any programming language. This helps to reuse core data models in different environments.

Specification Generator

Simple model

A simple model with some scalar properties.
{
  "title": "Student",
  "type": "object",
  "properties": {
    "firstName": {
      "type": "string"
    },
    "lastName": {
      "type": "string"
    },
    "age": {
      "type": "integer"
    }
  }
}
public class Student
{
    public string FirstName { get; set; }
    public string LastName { get; set; }
    public int Age { get; set; }
}

// Student
type Student struct {
    firstName string `json:"firstName"`
    lastName string `json:"lastName"`
    age int `json:"age"`
}

<div id="Student" class="psx-object psx-struct"><h1><a href="#Student">Student</a></h1><pre class="psx-object-json"><span class="psx-object-json-pun">{</span>
  <span class="psx-object-json-key">"firstName"</span><span class="psx-object-json-pun">: </span><span class="psx-property-type">String</span><span class="psx-object-json-pun">,</span>
  <span class="psx-object-json-key">"lastName"</span><span class="psx-object-json-pun">: </span><span class="psx-property-type">String</span><span class="psx-object-json-pun">,</span>
  <span class="psx-object-json-key">"age"</span><span class="psx-object-json-pun">: </span><span class="psx-property-type">Integer</span><span class="psx-object-json-pun">,</span>
<span class="psx-object-json-pun">}</span></pre><table class="table psx-object-properties"><colgroup><col width="30%" /><col width="70%" /></colgroup><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><span class="psx-property-name psx-property-optional">firstName</span></td><td><span class="psx-property-type">String</span><br /><div class="psx-property-description"></div></td></tr><tr><td><span class="psx-property-name psx-property-optional">lastName</span></td><td><span class="psx-property-type">String</span><br /><div class="psx-property-description"></div></td></tr><tr><td><span class="psx-property-name psx-property-optional">age</span></td><td><span class="psx-property-type">Integer</span><br /><div class="psx-property-description"></div></td></tr></tbody></table></div>

public static class Student {
    private String firstName;
    private String lastName;
    private int age;
    public void setFirstName(String firstName) {
        this.firstName = firstName;
    }
    public String getFirstName() {
        return this.firstName;
    }
    public void setLastName(String lastName) {
        this.lastName = lastName;
    }
    public String getLastName() {
        return this.lastName;
    }
    public void setAge(int age) {
        this.age = age;
    }
    public int getAge() {
        return this.age;
    }
}

{
    "definitions": [],
    "title": "Student",
    "type": "object",
    "properties": {
        "firstName": {
            "type": "string"
        },
        "lastName": {
            "type": "string"
        },
        "age": {
            "type": "integer"
        }
    }
}
<a name="Student"></a>
# Student

Field | Type | Description | Constraints
----- | ---- | ----------- | -----------
firstName | String |  | 
lastName | String |  | 
age | Integer |  | 

/**
 * @Title("Student")
 */
class Student
{
    /**
     * @var string
     */
    protected $firstName;
    /**
     * @var string
     */
    protected $lastName;
    /**
     * @var int
     */
    protected $age;
    /**
     * @param string $firstName
     */
    public function setFirstName(?string $firstName)
    {
        $this->firstName = $firstName;
    }
    /**
     * @return string
     */
    public function getFirstName() : ?string
    {
        return $this->firstName;
    }
    /**
     * @param string $lastName
     */
    public function setLastName(?string $lastName)
    {
        $this->lastName = $lastName;
    }
    /**
     * @return string
     */
    public function getLastName() : ?string
    {
        return $this->lastName;
    }
    /**
     * @param int $age
     */
    public function setAge(?int $age)
    {
        $this->age = $age;
    }
    /**
     * @return int
     */
    public function getAge() : ?int
    {
        return $this->age;
    }
}
message Student {
    string firstName = 1;
    string lastName = 2;
    int64 age = 3;
}

class Student:
    def __init__(self, firstName: str, lastName: str, age: int):
        self.firstName = firstName
        self.lastName = lastName
        self.age = age

class Student: Codable {
    var firstName: String
    var lastName: String
    var age: Int
}

interface Student {
    firstName?: string
    lastName?: string
    age?: number
}

{
    "definitions": [],
    "title": "Student",
    "type": "object",
    "properties": {
        "firstName": {
            "type": "string"
        },
        "lastName": {
            "type": "string"
        },
        "age": {
            "type": "integer"
        }
    }
}

Model with references

A model mode which contains different references.
{
  "definitions": {
    "Location": {
      "type": "object",
      "properties": {
        "latitude": {
          "type": "number"
        },
        "longitude": {
          "type": "number"
        }
      }
    }
  },
  "title": "Student",
  "type": "object",
  "properties": {
    "firstName": {
      "type": "string"
    },
    "lastName": {
      "type": "string"
    },
    "age": {
      "type": "integer"
    },
    "origin": {
      "$ref": "Location"
    },
    "visited": {
      "type": "array",
      "items": {
        "$ref": "Location"
      }
    }
  }
}
public class Location
{
    public float Latitude { get; set; }
    public float Longitude { get; set; }
}

public class Student
{
    public string FirstName { get; set; }
    public string LastName { get; set; }
    public int Age { get; set; }
    public Location Origin { get; set; }
    public Location[] Visited { get; set; }
}

// Location
type Location struct {
    latitude float64 `json:"latitude"`
    longitude float64 `json:"longitude"`
}

// Student
type Student struct {
    firstName string `json:"firstName"`
    lastName string `json:"lastName"`
    age int `json:"age"`
    origin Location `json:"origin"`
    visited []Location `json:"visited"`
}

<div id="Location" class="psx-object psx-struct"><h1><a href="#Location">Location</a></h1><pre class="psx-object-json"><span class="psx-object-json-pun">{</span>
  <span class="psx-object-json-key">"latitude"</span><span class="psx-object-json-pun">: </span><span class="psx-property-type">Number</span><span class="psx-object-json-pun">,</span>
  <span class="psx-object-json-key">"longitude"</span><span class="psx-object-json-pun">: </span><span class="psx-property-type">Number</span><span class="psx-object-json-pun">,</span>
<span class="psx-object-json-pun">}</span></pre><table class="table psx-object-properties"><colgroup><col width="30%" /><col width="70%" /></colgroup><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><span class="psx-property-name psx-property-optional">latitude</span></td><td><span class="psx-property-type">Number</span><br /><div class="psx-property-description"></div></td></tr><tr><td><span class="psx-property-name psx-property-optional">longitude</span></td><td><span class="psx-property-type">Number</span><br /><div class="psx-property-description"></div></td></tr></tbody></table></div>

<div id="Student" class="psx-object psx-struct"><h1><a href="#Student">Student</a></h1><pre class="psx-object-json"><span class="psx-object-json-pun">{</span>
  <span class="psx-object-json-key">"firstName"</span><span class="psx-object-json-pun">: </span><span class="psx-property-type">String</span><span class="psx-object-json-pun">,</span>
  <span class="psx-object-json-key">"lastName"</span><span class="psx-object-json-pun">: </span><span class="psx-property-type">String</span><span class="psx-object-json-pun">,</span>
  <span class="psx-object-json-key">"age"</span><span class="psx-object-json-pun">: </span><span class="psx-property-type">Integer</span><span class="psx-object-json-pun">,</span>
  <span class="psx-object-json-key">"origin"</span><span class="psx-object-json-pun">: </span><span class="psx-property-type">Object (<a href="#Location">Location</a>)</span><span class="psx-object-json-pun">,</span>
  <span class="psx-object-json-key">"visited"</span><span class="psx-object-json-pun">: </span><span class="psx-property-type">Array (Object (<a href="#Location">Location</a>))</span><span class="psx-object-json-pun">,</span>
<span class="psx-object-json-pun">}</span></pre><table class="table psx-object-properties"><colgroup><col width="30%" /><col width="70%" /></colgroup><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><span class="psx-property-name psx-property-optional">firstName</span></td><td><span class="psx-property-type">String</span><br /><div class="psx-property-description"></div></td></tr><tr><td><span class="psx-property-name psx-property-optional">lastName</span></td><td><span class="psx-property-type">String</span><br /><div class="psx-property-description"></div></td></tr><tr><td><span class="psx-property-name psx-property-optional">age</span></td><td><span class="psx-property-type">Integer</span><br /><div class="psx-property-description"></div></td></tr><tr><td><span class="psx-property-name psx-property-optional">origin</span></td><td><span class="psx-property-type">Object (<a href="#Location">Location</a>)</span><br /><div class="psx-property-description"></div></td></tr><tr><td><span class="psx-property-name psx-property-optional">visited</span></td><td><span class="psx-property-type">Array (Object (<a href="#Location">Location</a>))</span><br /><div class="psx-property-description"></div></td></tr></tbody></table></div>

public static class Location {
    private float latitude;
    private float longitude;
    public void setLatitude(float latitude) {
        this.latitude = latitude;
    }
    public float getLatitude() {
        return this.latitude;
    }
    public void setLongitude(float longitude) {
        this.longitude = longitude;
    }
    public float getLongitude() {
        return this.longitude;
    }
}

public static class Student {
    private String firstName;
    private String lastName;
    private int age;
    private Location origin;
    private Location[] visited;
    public void setFirstName(String firstName) {
        this.firstName = firstName;
    }
    public String getFirstName() {
        return this.firstName;
    }
    public void setLastName(String lastName) {
        this.lastName = lastName;
    }
    public String getLastName() {
        return this.lastName;
    }
    public void setAge(int age) {
        this.age = age;
    }
    public int getAge() {
        return this.age;
    }
    public void setOrigin(Location origin) {
        this.origin = origin;
    }
    public Location getOrigin() {
        return this.origin;
    }
    public void setVisited(Location[] visited) {
        this.visited = visited;
    }
    public Location[] getVisited() {
        return this.visited;
    }
}

{
    "definitions": {
        "Location": {
            "type": "object",
            "properties": {
                "latitude": {
                    "type": "number"
                },
                "longitude": {
                    "type": "number"
                }
            }
        }
    },
    "title": "Student",
    "type": "object",
    "properties": {
        "firstName": {
            "type": "string"
        },
        "lastName": {
            "type": "string"
        },
        "age": {
            "type": "integer"
        },
        "origin": {
            "$ref": "#\/definitions\/Location"
        },
        "visited": {
            "type": "array",
            "items": {
                "$ref": "#\/definitions\/Location"
            }
        }
    }
}
<a name="Location"></a>
# Location

Field | Type | Description | Constraints
----- | ---- | ----------- | -----------
latitude | Number |  | 
longitude | Number |  | 

<a name="Student"></a>
# Student

Field | Type | Description | Constraints
----- | ---- | ----------- | -----------
firstName | String |  | 
lastName | String |  | 
age | Integer |  | 
origin | Object ([Location](#Location)) |  | 
visited | Array (Object ([Location](#Location))) |  | 

class Location
{
    /**
     * @var float
     */
    protected $latitude;
    /**
     * @var float
     */
    protected $longitude;
    /**
     * @param float $latitude
     */
    public function setLatitude(?float $latitude)
    {
        $this->latitude = $latitude;
    }
    /**
     * @return float
     */
    public function getLatitude() : ?float
    {
        return $this->latitude;
    }
    /**
     * @param float $longitude
     */
    public function setLongitude(?float $longitude)
    {
        $this->longitude = $longitude;
    }
    /**
     * @return float
     */
    public function getLongitude() : ?float
    {
        return $this->longitude;
    }
}
/**
 * @Title("Student")
 */
class Student
{
    /**
     * @var string
     */
    protected $firstName;
    /**
     * @var string
     */
    protected $lastName;
    /**
     * @var int
     */
    protected $age;
    /**
     * @var Location
     */
    protected $origin;
    /**
     * @var array<Location>
     */
    protected $visited;
    /**
     * @param string $firstName
     */
    public function setFirstName(?string $firstName)
    {
        $this->firstName = $firstName;
    }
    /**
     * @return string
     */
    public function getFirstName() : ?string
    {
        return $this->firstName;
    }
    /**
     * @param string $lastName
     */
    public function setLastName(?string $lastName)
    {
        $this->lastName = $lastName;
    }
    /**
     * @return string
     */
    public function getLastName() : ?string
    {
        return $this->lastName;
    }
    /**
     * @param int $age
     */
    public function setAge(?int $age)
    {
        $this->age = $age;
    }
    /**
     * @return int
     */
    public function getAge() : ?int
    {
        return $this->age;
    }
    /**
     * @param Location $origin
     */
    public function setOrigin(?Location $origin)
    {
        $this->origin = $origin;
    }
    /**
     * @return Location
     */
    public function getOrigin() : ?Location
    {
        return $this->origin;
    }
    /**
     * @param array<Location> $visited
     */
    public function setVisited(?array $visited)
    {
        $this->visited = $visited;
    }
    /**
     * @return array<Location>
     */
    public function getVisited() : ?array
    {
        return $this->visited;
    }
}
message Location {
    float latitude = 1;
    float longitude = 2;
}

message Student {
    string firstName = 1;
    string lastName = 2;
    int64 age = 3;
    Location origin = 4;
    repeated Location visited = 5;
}

class Location:
    def __init__(self, latitude: float, longitude: float):
        self.latitude = latitude
        self.longitude = longitude

class Student:
    def __init__(self, firstName: str, lastName: str, age: int, origin: Location, visited: List[Location]):
        self.firstName = firstName
        self.lastName = lastName
        self.age = age
        self.origin = origin
        self.visited = visited

class Location: Codable {
    var latitude: Float
    var longitude: Float
}

class Student: Codable {
    var firstName: String
    var lastName: String
    var age: Int
    var origin: Location
    var visited: Array<Location>
}

interface Location {
    latitude?: number
    longitude?: number
}

interface Student {
    firstName?: string
    lastName?: string
    age?: number
    origin?: Location
    visited?: Array<Location>
}

{
    "definitions": {
        "Location": {
            "type": "object",
            "properties": {
                "latitude": {
                    "type": "number"
                },
                "longitude": {
                    "type": "number"
                }
            }
        }
    },
    "title": "Student",
    "type": "object",
    "properties": {
        "firstName": {
            "type": "string"
        },
        "lastName": {
            "type": "string"
        },
        "age": {
            "type": "integer"
        },
        "origin": {
            "$ref": "Location"
        },
        "visited": {
            "type": "array",
            "items": {
                "$ref": "Location"
            }
        }
    }
}

Model with inheritance

A result set containing a model which extends a different model.
{
  "definitions": {
    "Human": {
      "type": "object",
      "properties": {
        "firstName": {
          "type": "string"
        },
        "lastName": {
          "type": "string"
        },
        "age": {
          "type": "integer"
        }
      }
    },
    "Student": {
      "$extends": "Human",
      "type": "object",
      "properties": {
        "studentId": {
          "type": "string"
        }
      }
    }
  },
  "title": "ResultSet",
  "type": "object",
  "properties": {
    "entries": {
      "type": "array",
      "items": {
        "$ref": "Student"
      }
    }
  }
}
public class Human
{
    public string FirstName { get; set; }
    public string LastName { get; set; }
    public int Age { get; set; }
}

public class Student extends Human
{
    public string StudentId { get; set; }
}

public class ResultSet
{
    public Student[] Entries { get; set; }
}

// Human
type Human struct {
    firstName string `json:"firstName"`
    lastName string `json:"lastName"`
    age int `json:"age"`
}

// Student
type Student struct {
    *Human
    studentId string `json:"studentId"`
}

// ResultSet
type ResultSet struct {
    entries []Student `json:"entries"`
}

<div id="Human" class="psx-object psx-struct"><h1><a href="#Human">Human</a></h1><pre class="psx-object-json"><span class="psx-object-json-pun">{</span>
  <span class="psx-object-json-key">"firstName"</span><span class="psx-object-json-pun">: </span><span class="psx-property-type">String</span><span class="psx-object-json-pun">,</span>
  <span class="psx-object-json-key">"lastName"</span><span class="psx-object-json-pun">: </span><span class="psx-property-type">String</span><span class="psx-object-json-pun">,</span>
  <span class="psx-object-json-key">"age"</span><span class="psx-object-json-pun">: </span><span class="psx-property-type">Integer</span><span class="psx-object-json-pun">,</span>
<span class="psx-object-json-pun">}</span></pre><table class="table psx-object-properties"><colgroup><col width="30%" /><col width="70%" /></colgroup><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><span class="psx-property-name psx-property-optional">firstName</span></td><td><span class="psx-property-type">String</span><br /><div class="psx-property-description"></div></td></tr><tr><td><span class="psx-property-name psx-property-optional">lastName</span></td><td><span class="psx-property-type">String</span><br /><div class="psx-property-description"></div></td></tr><tr><td><span class="psx-property-name psx-property-optional">age</span></td><td><span class="psx-property-type">Integer</span><br /><div class="psx-property-description"></div></td></tr></tbody></table></div>

<div id="Student" class="psx-object psx-struct"><h1><a href="#Student">Student</a> extends <a href="#Human">Human</a></h1><pre class="psx-object-json"><span class="psx-object-json-pun">{</span>
  <span class="psx-object-json-key">"studentId"</span><span class="psx-object-json-pun">: </span><span class="psx-property-type">String</span><span class="psx-object-json-pun">,</span>
<span class="psx-object-json-pun">}</span></pre><table class="table psx-object-properties"><colgroup><col width="30%" /><col width="70%" /></colgroup><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><span class="psx-property-name psx-property-optional">studentId</span></td><td><span class="psx-property-type">String</span><br /><div class="psx-property-description"></div></td></tr></tbody></table></div>

<div id="ResultSet" class="psx-object psx-struct"><h1><a href="#ResultSet">ResultSet</a></h1><pre class="psx-object-json"><span class="psx-object-json-pun">{</span>
  <span class="psx-object-json-key">"entries"</span><span class="psx-object-json-pun">: </span><span class="psx-property-type">Array (Object (<a href="#Student">Student</a>))</span><span class="psx-object-json-pun">,</span>
<span class="psx-object-json-pun">}</span></pre><table class="table psx-object-properties"><colgroup><col width="30%" /><col width="70%" /></colgroup><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><span class="psx-property-name psx-property-optional">entries</span></td><td><span class="psx-property-type">Array (Object (<a href="#Student">Student</a>))</span><br /><div class="psx-property-description"></div></td></tr></tbody></table></div>

public static class Human {
    private String firstName;
    private String lastName;
    private int age;
    public void setFirstName(String firstName) {
        this.firstName = firstName;
    }
    public String getFirstName() {
        return this.firstName;
    }
    public void setLastName(String lastName) {
        this.lastName = lastName;
    }
    public String getLastName() {
        return this.lastName;
    }
    public void setAge(int age) {
        this.age = age;
    }
    public int getAge() {
        return this.age;
    }
}

public static class Student extends Human {
    private String studentId;
    public void setStudentId(String studentId) {
        this.studentId = studentId;
    }
    public String getStudentId() {
        return this.studentId;
    }
}

public static class ResultSet {
    private Student[] entries;
    public void setEntries(Student[] entries) {
        this.entries = entries;
    }
    public Student[] getEntries() {
        return this.entries;
    }
}

{
    "definitions": {
        "Human": {
            "type": "object",
            "properties": {
                "firstName": {
                    "type": "string"
                },
                "lastName": {
                    "type": "string"
                },
                "age": {
                    "type": "integer"
                }
            }
        },
        "Student": {
            "allOf": [
                {
                    "$ref": "#\/definitions\/Human"
                },
                {
                    "type": "object",
                    "properties": {
                        "studentId": {
                            "type": "string"
                        }
                    }
                }
            ]
        }
    },
    "title": "ResultSet",
    "type": "object",
    "properties": {
        "entries": {
            "type": "array",
            "items": {
                "$ref": "#\/definitions\/Student"
            }
        }
    }
}
<a name="Human"></a>
# Human

Field | Type | Description | Constraints
----- | ---- | ----------- | -----------
firstName | String |  | 
lastName | String |  | 
age | Integer |  | 

<a name="Student"></a>
# Student

Field | Type | Description | Constraints
----- | ---- | ----------- | -----------
studentId | String |  | 

<a name="ResultSet"></a>
# ResultSet

Field | Type | Description | Constraints
----- | ---- | ----------- | -----------
entries | Array (Object ([Student](#Student))) |  | 

class Human
{
    /**
     * @var string
     */
    protected $firstName;
    /**
     * @var string
     */
    protected $lastName;
    /**
     * @var int
     */
    protected $age;
    /**
     * @param string $firstName
     */
    public function setFirstName(?string $firstName)
    {
        $this->firstName = $firstName;
    }
    /**
     * @return string
     */
    public function getFirstName() : ?string
    {
        return $this->firstName;
    }
    /**
     * @param string $lastName
     */
    public function setLastName(?string $lastName)
    {
        $this->lastName = $lastName;
    }
    /**
     * @return string
     */
    public function getLastName() : ?string
    {
        return $this->lastName;
    }
    /**
     * @param int $age
     */
    public function setAge(?int $age)
    {
        $this->age = $age;
    }
    /**
     * @return int
     */
    public function getAge() : ?int
    {
        return $this->age;
    }
}
class Student extends Human
{
    /**
     * @var string
     */
    protected $studentId;
    /**
     * @param string $studentId
     */
    public function setStudentId(?string $studentId)
    {
        $this->studentId = $studentId;
    }
    /**
     * @return string
     */
    public function getStudentId() : ?string
    {
        return $this->studentId;
    }
}
/**
 * @Title("ResultSet")
 */
class ResultSet
{
    /**
     * @var array<Student>
     */
    protected $entries;
    /**
     * @param array<Student> $entries
     */
    public function setEntries(?array $entries)
    {
        $this->entries = $entries;
    }
    /**
     * @return array<Student>
     */
    public function getEntries() : ?array
    {
        return $this->entries;
    }
}
message Human {
    string firstName = 1;
    string lastName = 2;
    int64 age = 3;
}

message Student {
    string studentId = 1;
}

message ResultSet {
    repeated Student entries = 1;
}

class Human:
    def __init__(self, firstName: str, lastName: str, age: int):
        self.firstName = firstName
        self.lastName = lastName
        self.age = age

class Student(Human):
    def __init__(self, studentId: str):
        self.studentId = studentId

class ResultSet:
    def __init__(self, entries: List[Student]):
        self.entries = entries

class Human: Codable {
    var firstName: String
    var lastName: String
    var age: Int
}

class Student: Human {
    var studentId: String
}

class ResultSet: Codable {
    var entries: Array<Student>
}

interface Human {
    firstName?: string
    lastName?: string
    age?: number
}

interface Student extends Human {
    studentId?: string
}

interface ResultSet {
    entries?: Array<Student>
}

{
    "definitions": {
        "Human": {
            "type": "object",
            "properties": {
                "firstName": {
                    "type": "string"
                },
                "lastName": {
                    "type": "string"
                },
                "age": {
                    "type": "integer"
                }
            }
        },
        "Student": {
            "$extends": "Human",
            "type": "object",
            "properties": {
                "studentId": {
                    "type": "string"
                }
            }
        }
    },
    "title": "ResultSet",
    "type": "object",
    "properties": {
        "entries": {
            "type": "array",
            "items": {
                "$ref": "Student"
            }
        }
    }
}

Advanced model which uses generics

A generic map which uses a specific model.
{
  "definitions": {
    "Student": {
      "type": "object",
      "properties": {
        "matricleNumber": {
          "type": "integer"
        }
      }
    },
    "StudentMap": {
      "$ref": "Map",
      "$template": {
        "T": "Student"
      }
    },
    "Map": {
      "type": "object",
      "properties": {
        "totalResults": {
          "type": "integer"
        },
        "entries": {
          "type": "array",
          "items": {
            "$generic": "T"
          }
        }
      }
    }
  },
  "title": "Faculty",
  "type": "object",
  "properties": {
    "description": {
      "type": "string"
    },
    "students": {
      "type": "array",
      "items": {
        "$ref": "StudentMap"
      }
    }
  }
}
public class Student
{
    public int MatricleNumber { get; set; }
}

public class StudentMap : Map<Student>
{
}

public class Map<T>
{
    public int TotalResults { get; set; }
    public T[] Entries { get; set; }
}

public class Faculty
{
    public string Description { get; set; }
    public StudentMap[] Students { get; set; }
}

// Student
type Student struct {
    matricleNumber int `json:"matricleNumber"`
}

// Map
type Map struct {
    totalResults int `json:"totalResults"`
    entries []T `json:"entries"`
}

// Faculty
type Faculty struct {
    description string `json:"description"`
    students []StudentMap `json:"students"`
}

<div id="Student" class="psx-object psx-struct"><h1><a href="#Student">Student</a></h1><pre class="psx-object-json"><span class="psx-object-json-pun">{</span>
  <span class="psx-object-json-key">"matricleNumber"</span><span class="psx-object-json-pun">: </span><span class="psx-property-type">Integer</span><span class="psx-object-json-pun">,</span>
<span class="psx-object-json-pun">}</span></pre><table class="table psx-object-properties"><colgroup><col width="30%" /><col width="70%" /></colgroup><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><span class="psx-property-name psx-property-optional">matricleNumber</span></td><td><span class="psx-property-type">Integer</span><br /><div class="psx-property-description"></div></td></tr></tbody></table></div>

<div id="StudentMap" class="psx-object psx-reference"><h1><a href="#StudentMap">StudentMap</a></h1><pre class="psx-object-json">Reference: Object (<a href="#Map">Map</a>)
<span class="psx-object-json-key">"T"</span><span class="psx-object-json-pun"> = </span><span class="psx-property-type"><a href="#Student">Student</a></span></pre></div>

<div id="Map" class="psx-object psx-struct"><h1><a href="#Map">Map</a>&lt;T&gt;</h1><pre class="psx-object-json"><span class="psx-object-json-pun">{</span>
  <span class="psx-object-json-key">"totalResults"</span><span class="psx-object-json-pun">: </span><span class="psx-property-type">Integer</span><span class="psx-object-json-pun">,</span>
  <span class="psx-object-json-key">"entries"</span><span class="psx-object-json-pun">: </span><span class="psx-property-type">Array (T)</span><span class="psx-object-json-pun">,</span>
<span class="psx-object-json-pun">}</span></pre><table class="table psx-object-properties"><colgroup><col width="30%" /><col width="70%" /></colgroup><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><span class="psx-property-name psx-property-optional">totalResults</span></td><td><span class="psx-property-type">Integer</span><br /><div class="psx-property-description"></div></td></tr><tr><td><span class="psx-property-name psx-property-optional">entries</span></td><td><span class="psx-property-type">Array (T)</span><br /><div class="psx-property-description"></div></td></tr></tbody></table></div>

<div id="Faculty" class="psx-object psx-struct"><h1><a href="#Faculty">Faculty</a></h1><pre class="psx-object-json"><span class="psx-object-json-pun">{</span>
  <span class="psx-object-json-key">"description"</span><span class="psx-object-json-pun">: </span><span class="psx-property-type">String</span><span class="psx-object-json-pun">,</span>
  <span class="psx-object-json-key">"students"</span><span class="psx-object-json-pun">: </span><span class="psx-property-type">Array (Object (<a href="#StudentMap">StudentMap</a>))</span><span class="psx-object-json-pun">,</span>
<span class="psx-object-json-pun">}</span></pre><table class="table psx-object-properties"><colgroup><col width="30%" /><col width="70%" /></colgroup><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><span class="psx-property-name psx-property-optional">description</span></td><td><span class="psx-property-type">String</span><br /><div class="psx-property-description"></div></td></tr><tr><td><span class="psx-property-name psx-property-optional">students</span></td><td><span class="psx-property-type">Array (Object (<a href="#StudentMap">StudentMap</a>))</span><br /><div class="psx-property-description"></div></td></tr></tbody></table></div>

public static class Student {
    private int matricleNumber;
    public void setMatricleNumber(int matricleNumber) {
        this.matricleNumber = matricleNumber;
    }
    public int getMatricleNumber() {
        return this.matricleNumber;
    }
}

public class StudentMap extends Map<Student> {
}

public static class Map<T> {
    private int totalResults;
    private T[] entries;
    public void setTotalResults(int totalResults) {
        this.totalResults = totalResults;
    }
    public int getTotalResults() {
        return this.totalResults;
    }
    public void setEntries(T[] entries) {
        this.entries = entries;
    }
    public T[] getEntries() {
        return this.entries;
    }
}

public static class Faculty {
    private String description;
    private StudentMap[] students;
    public void setDescription(String description) {
        this.description = description;
    }
    public String getDescription() {
        return this.description;
    }
    public void setStudents(StudentMap[] students) {
        this.students = students;
    }
    public StudentMap[] getStudents() {
        return this.students;
    }
}

{
    "definitions": {
        "Map": {
            "type": "object",
            "properties": {
                "totalResults": {
                    "type": "integer"
                },
                "entries": {
                    "type": "array",
                    "items": {
                        "$generic": "T"
                    }
                }
            }
        },
        "Student": {
            "type": "object",
            "properties": {
                "matricleNumber": {
                    "type": "integer"
                }
            }
        },
        "StudentMap": {
            "$ref": "#\/definitions\/Map"
        }
    },
    "title": "Faculty",
    "type": "object",
    "properties": {
        "description": {
            "type": "string"
        },
        "students": {
            "type": "array",
            "items": {
                "$ref": "#\/definitions\/StudentMap"
            }
        }
    }
}
<a name="Student"></a>
# Student

Field | Type | Description | Constraints
----- | ---- | ----------- | -----------
matricleNumber | Integer |  | 

<a name="Map"></a>
# Map

Field | Type | Description | Constraints
----- | ---- | ----------- | -----------
totalResults | Integer |  | 
entries | Array (T) |  | 

<a name="Faculty"></a>
# Faculty

Field | Type | Description | Constraints
----- | ---- | ----------- | -----------
description | String |  | 
students | Array (Object ([StudentMap](#StudentMap))) |  | 

class Student
{
    /**
     * @var int
     */
    protected $matricleNumber;
    /**
     * @param int $matricleNumber
     */
    public function setMatricleNumber(?int $matricleNumber)
    {
        $this->matricleNumber = $matricleNumber;
    }
    /**
     * @return int
     */
    public function getMatricleNumber() : ?int
    {
        return $this->matricleNumber;
    }
}
/**
 * @extends Map<Student>
 */
class StudentMap extends Map
{
}
/**
 * @template T
 */
class Map
{
    /**
     * @var int
     */
    protected $totalResults;
    /**
     * @var array<T>
     */
    protected $entries;
    /**
     * @param int $totalResults
     */
    public function setTotalResults(?int $totalResults)
    {
        $this->totalResults = $totalResults;
    }
    /**
     * @return int
     */
    public function getTotalResults() : ?int
    {
        return $this->totalResults;
    }
    /**
     * @param array<T> $entries
     */
    public function setEntries(?array $entries)
    {
        $this->entries = $entries;
    }
    /**
     * @return array<T>
     */
    public function getEntries() : ?array
    {
        return $this->entries;
    }
}
/**
 * @Title("Faculty")
 */
class Faculty
{
    /**
     * @var string
     */
    protected $description;
    /**
     * @var array<StudentMap>
     */
    protected $students;
    /**
     * @param string $description
     */
    public function setDescription(?string $description)
    {
        $this->description = $description;
    }
    /**
     * @return string
     */
    public function getDescription() : ?string
    {
        return $this->description;
    }
    /**
     * @param array<StudentMap> $students
     */
    public function setStudents(?array $students)
    {
        $this->students = $students;
    }
    /**
     * @return array<StudentMap>
     */
    public function getStudents() : ?array
    {
        return $this->students;
    }
}
message Student {
    int64 matricleNumber = 1;
}

message Map {
    int64 totalResults = 1;
    repeated T entries = 2;
}

message Faculty {
    string description = 1;
    repeated StudentMap students = 2;
}

class Student:
    def __init__(self, matricleNumber: int):
        self.matricleNumber = matricleNumber

class StudentMap(Map):

class Map:
    def __init__(self, totalResults: int, entries: List[T]):
        self.totalResults = totalResults
        self.entries = entries

class Faculty:
    def __init__(self, description: str, students: List[StudentMap]):
        self.description = description
        self.students = students

class Student: Codable {
    var matricleNumber: Int
}

typealias StudentMap = Map<Student>;

class Map: Codable {
    var totalResults: Int
    var entries: Array<T>
}

class Faculty: Codable {
    var description: String
    var students: Array<StudentMap>
}

interface Student {
    matricleNumber?: number
}

type StudentMap = Map<Student>;

interface Map<T> {
    totalResults?: number
    entries?: Array<T>
}

interface Faculty {
    description?: string
    students?: Array<StudentMap>
}

{
    "definitions": {
        "Map": {
            "type": "object",
            "properties": {
                "totalResults": {
                    "type": "integer"
                },
                "entries": {
                    "type": "array",
                    "items": {
                        "$generic": "T"
                    }
                }
            }
        },
        "Student": {
            "type": "object",
            "properties": {
                "matricleNumber": {
                    "type": "integer"
                }
            }
        },
        "StudentMap": {
            "$ref": "Map",
            "$template": {
                "T": "Student"
            }
        }
    },
    "title": "Faculty",
    "type": "object",
    "properties": {
        "description": {
            "type": "string"
        },
        "students": {
            "type": "array",
            "items": {
                "$ref": "StudentMap"
            }
        }
    }
}

Import other TypeSchema specification

Shows how to import and use another TypeSchema.
{
  "$import": {
    "my_ns": "https://raw.githubusercontent.com/apioo/typeschema/master/www/src/Website/resource/examples/generic.json"
  },
  "title": "Faculty",
  "type": "object",
  "properties": {
    "description": {
      "type": "string"
    },
    "students": {
      "type": "array",
      "items": {
        "$ref": "my_ns:StudentMap"
      }
    }
  }
}
public class Student
{
    public int MatricleNumber { get; set; }
}

public class StudentMap : Map<Student>
{
}

public class Map<T>
{
    public int TotalResults { get; set; }
    public T[] Entries { get; set; }
}

public class Faculty
{
    public string Description { get; set; }
    public my_ns:StudentMap[] Students { get; set; }
}

// Student
type Student struct {
    matricleNumber int `json:"matricleNumber"`
}

// Map
type Map struct {
    totalResults int `json:"totalResults"`
    entries []T `json:"entries"`
}

// Faculty
type Faculty struct {
    description string `json:"description"`
    students []my_ns:StudentMap `json:"students"`
}

<div id="Student" class="psx-object psx-struct"><h1><a href="#Student">Student</a></h1><pre class="psx-object-json"><span class="psx-object-json-pun">{</span>
  <span class="psx-object-json-key">"matricleNumber"</span><span class="psx-object-json-pun">: </span><span class="psx-property-type">Integer</span><span class="psx-object-json-pun">,</span>
<span class="psx-object-json-pun">}</span></pre><table class="table psx-object-properties"><colgroup><col width="30%" /><col width="70%" /></colgroup><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><span class="psx-property-name psx-property-optional">matricleNumber</span></td><td><span class="psx-property-type">Integer</span><br /><div class="psx-property-description"></div></td></tr></tbody></table></div>

<div id="StudentMap" class="psx-object psx-reference"><h1><a href="#StudentMap">StudentMap</a></h1><pre class="psx-object-json">Reference: Object (<a href="#Map">Map</a>)
<span class="psx-object-json-key">"T"</span><span class="psx-object-json-pun"> = </span><span class="psx-property-type"><a href="#Student">Student</a></span></pre></div>

<div id="Map" class="psx-object psx-struct"><h1><a href="#Map">Map</a>&lt;T&gt;</h1><pre class="psx-object-json"><span class="psx-object-json-pun">{</span>
  <span class="psx-object-json-key">"totalResults"</span><span class="psx-object-json-pun">: </span><span class="psx-property-type">Integer</span><span class="psx-object-json-pun">,</span>
  <span class="psx-object-json-key">"entries"</span><span class="psx-object-json-pun">: </span><span class="psx-property-type">Array (T)</span><span class="psx-object-json-pun">,</span>
<span class="psx-object-json-pun">}</span></pre><table class="table psx-object-properties"><colgroup><col width="30%" /><col width="70%" /></colgroup><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><span class="psx-property-name psx-property-optional">totalResults</span></td><td><span class="psx-property-type">Integer</span><br /><div class="psx-property-description"></div></td></tr><tr><td><span class="psx-property-name psx-property-optional">entries</span></td><td><span class="psx-property-type">Array (T)</span><br /><div class="psx-property-description"></div></td></tr></tbody></table></div>

<div id="Faculty" class="psx-object psx-struct"><h1><a href="#Faculty">Faculty</a></h1><pre class="psx-object-json"><span class="psx-object-json-pun">{</span>
  <span class="psx-object-json-key">"description"</span><span class="psx-object-json-pun">: </span><span class="psx-property-type">String</span><span class="psx-object-json-pun">,</span>
  <span class="psx-object-json-key">"students"</span><span class="psx-object-json-pun">: </span><span class="psx-property-type">Array (Object (<a href="#my_ns:StudentMap">my_ns:StudentMap</a>))</span><span class="psx-object-json-pun">,</span>
<span class="psx-object-json-pun">}</span></pre><table class="table psx-object-properties"><colgroup><col width="30%" /><col width="70%" /></colgroup><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><span class="psx-property-name psx-property-optional">description</span></td><td><span class="psx-property-type">String</span><br /><div class="psx-property-description"></div></td></tr><tr><td><span class="psx-property-name psx-property-optional">students</span></td><td><span class="psx-property-type">Array (Object (<a href="#my_ns:StudentMap">my_ns:StudentMap</a>))</span><br /><div class="psx-property-description"></div></td></tr></tbody></table></div>

public static class Student {
    private int matricleNumber;
    public void setMatricleNumber(int matricleNumber) {
        this.matricleNumber = matricleNumber;
    }
    public int getMatricleNumber() {
        return this.matricleNumber;
    }
}

public class StudentMap extends Map<Student> {
}

public static class Map<T> {
    private int totalResults;
    private T[] entries;
    public void setTotalResults(int totalResults) {
        this.totalResults = totalResults;
    }
    public int getTotalResults() {
        return this.totalResults;
    }
    public void setEntries(T[] entries) {
        this.entries = entries;
    }
    public T[] getEntries() {
        return this.entries;
    }
}

public static class Faculty {
    private String description;
    private my_ns:StudentMap[] students;
    public void setDescription(String description) {
        this.description = description;
    }
    public String getDescription() {
        return this.description;
    }
    public void setStudents(my_ns:StudentMap[] students) {
        this.students = students;
    }
    public my_ns:StudentMap[] getStudents() {
        return this.students;
    }
}

{
    "definitions": {
        "Map": {
            "type": "object",
            "properties": {
                "totalResults": {
                    "type": "integer"
                },
                "entries": {
                    "type": "array",
                    "items": {
                        "$generic": "T"
                    }
                }
            }
        },
        "Student": {
            "type": "object",
            "properties": {
                "matricleNumber": {
                    "type": "integer"
                }
            }
        },
        "StudentMap": {
            "$ref": "#\/definitions\/Map"
        }
    },
    "title": "Faculty",
    "type": "object",
    "properties": {
        "description": {
            "type": "string"
        },
        "students": {
            "type": "array",
            "items": {
                "$ref": "#\/definitions\/my_ns:StudentMap"
            }
        }
    }
}
<a name="Student"></a>
# Student

Field | Type | Description | Constraints
----- | ---- | ----------- | -----------
matricleNumber | Integer |  | 

<a name="Map"></a>
# Map

Field | Type | Description | Constraints
----- | ---- | ----------- | -----------
totalResults | Integer |  | 
entries | Array (T) |  | 

<a name="Faculty"></a>
# Faculty

Field | Type | Description | Constraints
----- | ---- | ----------- | -----------
description | String |  | 
students | Array (Object ([my_ns:StudentMap](#my_ns:StudentMap))) |  | 

class Student
{
    /**
     * @var int
     */
    protected $matricleNumber;
    /**
     * @param int $matricleNumber
     */
    public function setMatricleNumber(?int $matricleNumber)
    {
        $this->matricleNumber = $matricleNumber;
    }
    /**
     * @return int
     */
    public function getMatricleNumber() : ?int
    {
        return $this->matricleNumber;
    }
}
/**
 * @extends Map<Student>
 */
class StudentMap extends Map
{
}
/**
 * @template T
 */
class Map
{
    /**
     * @var int
     */
    protected $totalResults;
    /**
     * @var array<T>
     */
    protected $entries;
    /**
     * @param int $totalResults
     */
    public function setTotalResults(?int $totalResults)
    {
        $this->totalResults = $totalResults;
    }
    /**
     * @return int
     */
    public function getTotalResults() : ?int
    {
        return $this->totalResults;
    }
    /**
     * @param array<T> $entries
     */
    public function setEntries(?array $entries)
    {
        $this->entries = $entries;
    }
    /**
     * @return array<T>
     */
    public function getEntries() : ?array
    {
        return $this->entries;
    }
}
/**
 * @Title("Faculty")
 */
class Faculty
{
    /**
     * @var string
     */
    protected $description;
    /**
     * @var array<my_ns:StudentMap>
     */
    protected $students;
    /**
     * @param string $description
     */
    public function setDescription(?string $description)
    {
        $this->description = $description;
    }
    /**
     * @return string
     */
    public function getDescription() : ?string
    {
        return $this->description;
    }
    /**
     * @param array<my_ns:StudentMap> $students
     */
    public function setStudents(?array $students)
    {
        $this->students = $students;
    }
    /**
     * @return array<my_ns:StudentMap>
     */
    public function getStudents() : ?array
    {
        return $this->students;
    }
}
message Student {
    int64 matricleNumber = 1;
}

message Map {
    int64 totalResults = 1;
    repeated T entries = 2;
}

message Faculty {
    string description = 1;
    repeated my_ns:StudentMap students = 2;
}

class Student:
    def __init__(self, matricleNumber: int):
        self.matricleNumber = matricleNumber

class StudentMap(Map):

class Map:
    def __init__(self, totalResults: int, entries: List[T]):
        self.totalResults = totalResults
        self.entries = entries

class Faculty:
    def __init__(self, description: str, students: List[my_ns:StudentMap]):
        self.description = description
        self.students = students

class Student: Codable {
    var matricleNumber: Int
}

typealias StudentMap = Map<Student>;

class Map: Codable {
    var totalResults: Int
    var entries: Array<T>
}

class Faculty: Codable {
    var description: String
    var students: Array<my_ns:StudentMap>
}

interface Student {
    matricleNumber?: number
}

type StudentMap = Map<Student>;

interface Map<T> {
    totalResults?: number
    entries?: Array<T>
}

interface Faculty {
    description?: string
    students?: Array<my_ns:StudentMap>
}

{
    "definitions": {
        "Map": {
            "type": "object",
            "properties": {
                "totalResults": {
                    "type": "integer"
                },
                "entries": {
                    "type": "array",
                    "items": {
                        "$generic": "T"
                    }
                }
            }
        },
        "Student": {
            "type": "object",
            "properties": {
                "matricleNumber": {
                    "type": "integer"
                }
            }
        },
        "StudentMap": {
            "$ref": "Map",
            "$template": {
                "T": "Student"
            }
        }
    },
    "title": "Faculty",
    "type": "object",
    "properties": {
        "description": {
            "type": "string"
        },
        "students": {
            "type": "array",
            "items": {
                "$ref": "my_ns:StudentMap"
            }
        }
    }
}