RAML API baseUriParameters未使用的模板参数错误

时间:2017-01-19 14:06:19

标签: rest api-design raml

我想为我的API中的每个客户创建一个不同的基本URI,因此端点是相同的,但我可以过滤客户。我认为向基URI添加模板参数是解决方案,但我如何使用baseUriParameter

我已将RAML规范导入到APIMATIC baseUriParameter

baseUri: http://{fi}.api.mycompany.com
baseUriParameters:
  fi:
    type: string

此模板参数作为参数添加到每个端点。这是一个示例端点。

/users:
  get:

这会显示错误消息。

  

“Endpoint Users有一个名为fi的未使用模板参数。”

APIMATIC已将参数添加到端点。 APIMATIC Edit Parameter

这也意味着没有自动生成测试用例。

如何使用baseUriParameter

1 个答案:

答案 0 :(得分:1)

尝试再次导入RAML API描述文件。 APIMATIC将使用您的baseUri并立即创建模板参数。您可以查看Server Configuration页面,查看baseUri中的哪些参数已被识别,并为其设置默认值。

enter image description here

baseUri中的服务器配置和模板参数的参考文档:https://docs.apimatic.io/api-editor/server-configuration/

希望这有帮助!