省略MSON中定义的对象的属性

时间:2016-06-12 15:12:57

标签: apiblueprint apiary.io mson

如何从已定义的MSON中省略属性?我使用MSON定义了一个简单的实体(对象):

Article

我在几个api端点使用id对象。问题是我不希望在发布新文章时指定POST,因此我想在Article方法的文档中省略它。是否可以在所有端点中包含hello实体并说明我想省略哪些字段?

1 个答案:

答案 0 :(得分:2)

实际上没有办法如何做到这一点。 您有两种选择:

  • 使用属性id

  • 声明nullable
  • 在没有Article的情况下声明id,然后从Article继承并附加id

# Data Structures

## Article (object)
+ name: My first article (string)

## ArticleInstance (Article)
+ id (number)

## Articles [/articles]

### Get all articles [GET]

Get all articles available on this website.

+ Response 200 (application/json)
 + Attributes (array[Article])

### Create an article [POST]

Create new article.

+ Request (application/json)
    + Attributes (Article)