Example API with RAML Step 5

api.raml

# document root

types:
  Error:
    properties:
      code: integer
      message: string
  Gender:
    type: string
    enum: [ male, female ]
  UserBase:
    properties:
      name: string
      gender?: Gender
  User:
    properties:
      id: integer
      name: string
      gender?: Gender
    example:
      {
        "id": 42,
        "name": "John Doe",
        "gender": "male"
      }
  Users: User[]

/users:
  get:
    description: Get all users.
    responses:
      200:
        body:
          type: Users
  post:
    description: Create new user.
    body:
      type: UserBase
    responses:
      201:
        description: New user created successful.
      400:
        description: Required properties missing or validation issues.
        body:
          type: Error