Example API with RAML Step 7

api.raml

# document root and types

traits:
  BadRequest:
    responses:
      400:
        description: Required properties missing or validation issues.
        body:
          type: Error

resourceTypes:
  NotFound:
    put:
      responses:
        404:
          description: Unkown <<resourcePathName>>.
          body:
            type: Error

/users:
  # get operation
  post:
    description: Create new user.
    is: BadRequest
    body:
      type: UserBase
    responses:
      201:
        description: New user created successful.
  /{userId}:
    type: NotFound
    uriParameters:
      userId: integer
    put:
      description: Update user.
      is: BadRequest
      body:
        type: UserBase
      responses:
        200:
          description: User updated successful.
          body:
            type: User