3

我正在使用 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 函数的地方”。

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

4

3 回答 3

0

在 swagger-php 0.9.1 中修复

我不知道为什么 swagger-ui 会剥离".{format}"但没有".json"

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

于 2014-03-21T15:04:36.913 回答
0

swagger-php我也遇到了这个问题,但是我在提到这个的或swagger-uigithub 页面上都找不到任何东西。因此,我编写了一个简短的构建脚本(假设是类 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
于 2014-03-13T18:32:59.693 回答
0

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

于 2014-03-09T22:57:34.147 回答