如何定义字符串参数必须采用的格式？

Question

我们有一个名为imageDimensions的查询字符串参数,它为不同类型的图像指定所需的尺寸.例如?imageDimensions=poster:600x800,badge:100x100

API Blueprint中是否有一种方法可以指定imageDimensions应该是逗号分隔的图像尺寸规格列表,每种形式都是"(图像类型):(宽度)x(高度)"？

Answer 1

目前没有好的专用语法.我可能会喜欢这样的东西:

## GET /resource{?imageDimensions}
+ Parameters
    + imageDimensions (string, optional) - Comma-separated list of image dimension specs, each of form `(image type):(width)x(height)`

        Where the `(image type)` is one of the following:

        - badge
        - poster
        - icon

        + Sample: `badge:100x100`
        + Sample: `poster:600x800`
        + Sample: `poster:600x800,badge:100x100`

+ Response 200

注意,计划在不久的将来将参数语法移动到完整的MSON语法.请参阅API 蓝图路线图.

有了它,应该可以将图像的类型定义为a enum,然后在蓝图中引用它.