swagger - 如何让 Swagger UI 使用我的标题？

Question

我正在使用 Swagger-php 和 Swagger-UI，一切正常，但有一个烦恼。 Swagger-UI 创建的 UI 具有我的 API 路由的预期点击展开部分，但每个部分的标题似乎是生成的 JSON 文件，而不是我可以给它的任何名称。标题后的描述是我在注释中给出的，但标题我似乎无法控制。

因此，如果我有以/foo 的 resourcePath 开头的路由，以及描述为“Foo API 函数”的说明，则 UI 如下所示:

foo.json:Foo API 函数

我不想要“foo.json”我更愿意指定它说的是什么。就像“Foo”甚至“Foo Functions”，然后将我的描述更改为更有意义的内容，例如“这是您找到 foo 函数的地方。”

我是否缺少为此使用的注释？

Answer 1

如果您手动编辑 api-docs.json 文件。您可以将 .json 替换为 .{format}，所有这些都将正确显示并正常运行。不确定为什么默认情况下不插入 .{format}。有点烦人。