是否可以在RAML文件中添加重定向链接,例如到另一个API版本?

时间:2016-02-26 13:14:34

标签: api documentation raml

在主题中,我有两个RAML文件,一个与v1 API版本相关,第二个属于v2 API版本。我的问题是,如果我通过API文档传递给某人我的根URL我不确定当有人进入API v1页面时,他将能够获得一些信息("这是旧的api请转到API v2:link")并将链接重定向到API v2?

有没有办法将此重定向链接放入v1 RAML文件?

感谢任何回复

2 个答案:

答案 0 :(得分:1)

documentation部分支持Markdown,因此您可以轻松地在其中插入链接。

答案 1 :(得分:0)

是的,如果无法使用直接网址,则可以添加直接网址,也可以尝试使用以下语法

response:
  200:
    example:
      {
        "redirecturl":"URL Location"
      }