当前位置: 首页 > 知识库问答 >
问题:

如何链接到Swagger中的另一个endpoint

朱锐
2023-03-14

我正在为未来的公共API编写一个招摇过市的规范,它需要非常详细和干净的文档。是否有方法在swagger中的其他位置引用/链接/指向另一个endpoint。yml文件?

例如,这是我正在努力实现的目标:

paths:
  /my/endpoint:
    post:
      tags:
        - Some tag
      summary: Do things
      description: >
        This endpoint does things.
        See /my/otherEndpoint for stuff  # Here I would like to have some kind of hyperlink
      operationId: doThings
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        ...
      responses:
        ...
  /my/otherEndpoint:  # This is the endpoint to be referenced to
    get:
      ...

我发现$ref没有帮助,因为它只是用引用的内容替换自己。

斯威格能做这种事吗?

共有1个答案

尹赞
2023-03-14

如果Swagger UI配置了deepLinking:true选项,则它为标记和操作提供永久链接。这些永久链接是根据标记名和操作ID生成的(如果没有操作ID,则根据endpoint名称和HTTP谓词生成)。

index.html#/tagName
index.html#/tagName/operationId

您可以在Markdown标记中使用这些永久链接:

      description: >
        This endpoint does things.
        See [/my/otherEndpoint](#/tagName/myOtherEndpointId) for stuff

笔记

  • 当前在新浏览器选项卡中打开的降价链接(如上文所述)(如target=“\u blank”)-请参阅问题3473
 类似资料:
  • 我想知道如何链接到同一liferay网站中的另一个页面。 显然,我可以在我的portlet视图中硬编码url,但是我担心必须更新所有的portlet,以防友好的url在未来发生变化。 我知道我试图链接到的页面的名称,但是如果页面名称也改变了呢? 我发现了无数具有返回友好URL的方法的类,例如,,甚至,但它们都需要我不确定如何获取的参数。 是否有一个标准的方式获得友好的网址?

  • 问题内容: 我有两个包,和: 我正在为JavaDoc编写代码,并且需要提供to 。 我已经尝试了以下所有方法,但都不起作用: 我已经找到链接到以下文档的文档:(a)同一包中的类,或(b)外部URL,但另一个包中的类。 任何想法正确的语法应该是什么?谢谢! 问题答案: 在正确的语法变种 您缺少完整的软件包。下面的例子应该是正确的

  • 问题内容: 如果我有:和 如果调用,我是否可以通过这种方式将linkedlist2附加到linkedlist1的末尾: 它变为并 变为? 那可能吗 ?还是我需要其他结构? 以下代码不起作用: 输出: 问题答案: Java提供的标准LinkedList类缺少此功能。 正如Donal Boyle所发布的那样,您可以将一个列表的内容添加到另一个列表中,但这并不能像您所描述的那样保持链接。

  • 谁能帮助我如何创建一个新的代理人,并将其链接到旧的,以治愈人民? 多谢!

  • 问题内容: 我正在研究数据结构和链表,但是我没有得到如何制作链表副本的概念。有人可以使用伪代码或C代码进行解释吗? 问题答案: 复制链表的逻辑是递归的,并且基于以下观察结果: 空列表的克隆是空列表。 具有第一个节点x和其余节点xs的列表的克隆是x的副本,该副本位于xs的克隆之前。 如果您使用C ++对链表进行编码,则可以很干净:

  • 问题内容: 我在类中为我的方法添加了一些描述。这就是我实现这一目标的方式: 如何使带下划线的方法可点击?我希望引用它,以便当用户单击它时,他们将被定向到特定的网页进行 文档编制。 可能吗 预先感谢,任何帮助将不胜感激 问题答案: Xcode本身支持文档注释,可在快速帮助中(在⌥单击符号时在弹出窗口中以及在快速帮助检查器中⌥⌘2)生成智能呈现的文档。 现在,符号文档注释基于丰富的游乐场注释所使用的M