Question

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

因此，如果我的路径以/ foo的resourcePath开头，并且描述为“Foo API Functions”，则UI看起来像：

foo.json：Foo API函数

我不想要“foo.json”我更愿意指出这句话。就像“Foo”甚至“Foo Functions”一样，然后将我的描述更改为更有意义的内容，例如“这就是你找到foo函数的地方。”

我错过了哪个注释用于此目的？

Answer 1

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

Answer 2

我也遇到了这个问题，但我无法在swagger-php或swagger-ui github页面上找到任何内容。所以，我写了一个简短的构建脚本（假设类似Unix的操作系统）作为一种解决方法，它将首先使用swagger.phar构建所有文档，然后运行sed来进行内联字符串替换。有问题的字符串。以下是我在下面所做的事情：

#!/bin/bash

# write API documentation from "src" directory to the "docs" directory
/usr/bin/php swagger.phar src -o docs

# replace instances of "json" with "{format}" to fix swagger-php formatting issue
sed -i -e 's/json/{format}/g' docs/api-docs.json

Answer 3

修复了swagger-php 0.9.1

我不知道为什么swagger-ui剥离".{format}"而不是".json"

默认情况下未插入.{format}，因为它可能会造成混淆。它表明存在不同的格式，而swagger-php仅支持json格式。

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

3 个答案: