Question

我有以下设计simple RAML的要求。我是RAML编码的新手，所以想知道我的代码是否符合要求

要求：

至少有一个端点采用GET和POST方法。
包含API的描述属性
包含方法的描述属性
GET请求的查询参数为“mulesoft”
使用包含最少字符串的对象定义响应整数数据类型
包含与200匹配的响应代码的示例定义来自上面的响应对象

我的代码：

#%RAML 1.0
title: Coding_Champions
version: 1.0.development
baseUri: http://localhost:8004/api
description: This API displays and adds Organisation with details

types:
  Org:
    type: object
    properties:
      name: string
      address: string
      pincode: integer
/details:
  displayName: Company Details
  description: Coding challenge which takes query parameter of "mulesoft"

  get:
    description: Retrieve a list of all the Orgs
    queryParameters:
      mulesoft: 
       description: Specify the Org name that you want to retrieve
       type:    boolean
       required: true
    responses:
      200:
        body:
          application/json:
            type: Org
            examples:
              MuleSoft:
                name: MuleSoft
                address: 77 Geary Street, Suite 400
                pincode: 94108
  post:
      description: Add a Org to list
      body: 
        application/json: 
            type: Org
            examples:
              Cognizant:
                name: Cognizant
                address: DLF
                pincode: 9771
      responses: 
        201:
          body: 
            application/json:
              example: |
                {
                "message":"New Org updated but not really"
                }

我更关心要求中的一点

"The GET request takes a query parameter of “mulesoft”

这是否意味着我应该在我的mulesoft中动态地提供url作为参数，如果是，那么除mulesoft之外的其他参数作为参数传递那么它应该抛出错误吗？

（或）

这是否意味着我需要像我现在所做的那样在我的“mulesoft”代码中硬编码RAML？

你能告诉我这个吗？

Answer 1

这是否意味着我需要像我一样在我的RAML代码中硬编码“mulesoft” 现在完成了吗？

是的。你应该像现在一样在RAML中定义它。因为它的必需参数，它的存在可以在实现中验证。

RAML代码理解

1 个答案: