[请教]关于结合使用 RAML 和 django restframework 的问题

V2EX = way to explore

V2EX 是一个关于分享和探索的地方

已注册用户请登录

这是一个创建于 2842 天前的主题，其中的信息可能已经有所发展或是发生改变。

尝试使用 api-workbench 写文档，使用 type:Pet[] 可以很方便的描述 list 接口的返回结果，但是，如果框架有分页功能，怎么在 list 外包一层呢。

文档的例子

#%RAML 1.0 
title: Pet shop
version: 1
baseUri: /shop
 
types:
  Pet:
    properties:
      name: string
      kind: string
      price: number
    example:
      name: "Snoopy"
      kind: "Mammal"
      price: 100
 
/pets:
  get:
    responses:
      200:
        body:
          application/json:
            type: Pet[]

真实接口返回的格式可能是:

{
  "page": 5,
  "next": "http://server.company.com/pets/?page=6",
  "results": [
      {
        "name": "aaa",
        "kind": "doge",
        "price": 998
      },
      ...
  ]
}

使用 RAML 格式应该怎么写比较好呢

1 条回复 • 2016-07-13 20:31:48 +08:00

jybox

2016-07-13 20:31:48 +08:00

/pets:
get:
responses:
200:
body:
application/json:
properties:
page: number
next: string
results: Pet[]