如何在RAML 1.0主文件中将Example作为DataType使用？

RAML 1.0官方原生支持将Example直接绑定到DataType使用，无需强制依赖外部.json/.xml文件引用，AnyPoint设计中心的对应操作入口完全适配该标准规范，具体用法如下：

基础用法示例 #

#%RAML 1.0
title: 用户查询API
version: 1.0.0

# 定义DataType的同时直接绑定内联Example
types:
  Employee:
    type: object
    description: 员工信息类型
    properties:
      empId: integer
      empName: string
      department: string
      joinDate: date
    # 直接内联声明示例，不需要额外引入外部文件
    example:
      empId: 1001
      empName: "张明"
      department: "研发部"
      joinDate: 2020-05-15

# 接口直接引用该DataType，会自动复用绑定的Example
/employee/{empId}:
  get:
    responses:
      200:
        body:
          application/json:
            type: Employee

AnyPoint设计中心操作说明 #

• 截图中的「选择Example作为DataType」功能，本质是将设计中心内预先创建的Example资源，自动映射为上述RAML规范中DataType绑定的示例，同时会自动根据Example的结构生成对应DataType的属性定义，无需手动逐个编写字段
• 如果需要在多个接口、多个数据类型中复用同一个示例结构，使用该功能比手动写内联示例、引用外部文件的维护成本更低，且设计中心会自动做Example和DataType的结构一致性校验

多示例绑定用法 #

如果同一个DataType需要绑定多个不同场景的示例，可以用examples字段声明，用法如下：

types:
  Employee:
    type: object
    properties:
      empId: integer
      empName: string
      department: string
      joinDate: date
    examples:
      正式员工:
        empId: 1001
        empName: "张明"
        department: "研发部"
        joinDate: 2020-05-15
      实习员工:
        empId: 2005
        empName: "李丽"
        department: "产品部"
        joinDate: 2024-02-01

内容的提问来源于stack exchange，提问作者Rizwan Shakoor