文档API请求,带有带有方括号的查询参数

时间:2019-11-21 22:49:23

标签: apiblueprint apiary

我正在尝试使用Apiary记录我的API。请求的URL具有包含对象的参数,因此该参数带有方括号。这是网址路径的示例

UPDATE ...
    CASE ...
        WHEN ...
        THEN ... 

我不知道如何获取文档中的URL以正确显示括号。 /api/path-request?filters[created_by]=248766&q=test&sort[0]=name&sortDir[0]=asc&page=2&limit=10 的文档编制方式给了我/api/path-request{?filters,q}

我也尝试过?filters=12345&q=map%20name,但这给了我一个URL /api/path-request?filters[created_by]={filters}&q={q}

1 个答案:

答案 0 :(得分:1)

@Michael Turnwall

在养蜂场文档中,明确提到可以使用documentation创建此类URL,其中提到可以将percent-encoded替换为方括号。例如,查看您的网址应为的示例。

/api/path-request?filters%5Bcreated_by%5D=248766&q=test&sort%50%5D=name&sortDir%5B0%5D=asc&page=2&limit=10

但是,仅供参考,我遇到了同样的问题,主要问题是您可以根据需要创建URL,但是由于服务器不支持它们,因此无法解决问题see here