api.raml

#%RAML 1.0
title: Test API
version: v1



baseUri: http://{apiMode}-mycompany.com/api/{version}
baseUriParameters:
  apiMode:
    description: Specifies the environment on which the API needs to be accessed.
    type: string
    enum: [esb-dev,esb-qa,esb]
    required: true

protocols: HTTP

types: 
  recordName:
    type: object
    properties: 
      recordID:
        type: integer
      desc:
        type: string
        
        
        

    
    

            
/records:
  get:
    description: An endpoint used to get detail about data records
    headers: 
      x-MOM-header:
        type: string
        example: "ClientName"
        required: false
        
    queryParameters: 
      mulesoft:
        type: number
        required: true
        example: 12376
        description: record number for seaching the record in the database.
    responses: 
      200: 
        body:
          application/json: 
            type: recordName
            example : {"recordID":1,"desc":"test"}