同一方法的两条路径

Question

一直在尝试使用 Swagger 为我的 PHP Rest API 生成文档，使用 swagger-php。

它工作得非常好，不太确定我是否喜欢由于文档而出现巨大的评论块，但这不是问题。

我有两条路：

/user/ [POST]
/user/login [POST]

它们都在我的 PHP 代码中调用相同的方法：login()。

我有没有办法说 /user/ [POST] 只是 /user/login [POST] 的别名？

我希望他们两个都出现在操作列表中，并附上他们的文档，并说他们做同样的事情，只是用不同的路径向用户提供选项。

我当然可以复制粘贴注释块，但我真的不希望一个 50 行的注释块用于只调用另一个方法的单行方法。

有什么想法吗？

Answer 1

使用 @SWG\Path 在 swagger-php 中已经可以使用引用。

/**
 * @SWG\Post(
 *   path="/user/login",
 *   @SWG\Response(response=200, description="OK")
 * )
 * @SWG\Path(path="/user/", ref="#/paths/user~1login");
 */
function login() {
  ...
}

但请记住，swagger 是为了记录您的 API，如果 /user/login 是用于登录的规范 API 端点，我什至不会在 swagger 文档中公开别名。

@Mark 在 swagger-php 中，path 仍然拥有 operations，但它使用 some tricks 自动创建 @SWG\Path，这避免了像一般的样板用例是为每个 php 方法记录一个 http 方法，但如果您的方法处理多个 http 方法，则直接使用 @SWG\Path 可能会更短：

/**
 * @SWG\Path(
 *   path="/example",
 *   @SWG\Get(response=200, description="OK"),
 *   @SWG\Post(response=200, description="OK"),
 *   @SWG\Put(response=200, description="OK")
 * )
 */
 function thisMethodHandlesGetPostAndPutRequests() {
 }

Answer 2

使用Swagger 2.0，您可以引用路径并避免重复文档。

示例：

{ “招摇”：2.0， “信息”：{ “版本”：“1.0.0”， “标题”：“宠物” }, “主机”：“本地主机：1234”， “方案”：[“http”]， “路径”：{ "/pet": { "$ref": "#/paths/x-endpoint-pet" }, “x-端点宠物”：{ “邮政”： { “标签”：[“宠物”] } } } }

swagger-php 自版本 2.0.6 起不支持此类引用。

这至少部分是由于swagger-php 中采用的具体实现方法。 php 实现颠倒了 path 和 operationown-owned 关系/em> 个对象。

在 Swagger 2.0 规范中，path 拥有 操作，而 path 可以引用其他路径。

在swagger-php 实现中，操作拥有路径。这会给人一种错误的印象，即操作可以有别名和/或拥有多个路径。

这是一个概念性问题，可能会在 swagger-php 的未来版本中得到解决。