Question

我已经使用API平台创建了一个自定义终结点。这是我使用的注释：

/**
 * We only want the POST option for now.
 *
 * @ApiResource(
 *      itemOperations={},
 *      collectionOperations={"post"={
 *           "method"="POST",
 *           "controller"=PairingController::class,
 *           "path"="/devices/pairing",
 *           "defaults"={"_api_receive"=false}
 *     }},
 * )
 *
 *
 */
class Pairing
{
...

我正在调用的控制器执行一些自定义逻辑。到目前为止，我对事情的进展感到满意。但是API平台生成的文档现在不准确。它说：

/ devices / pairing创建配对资源。

...这不再成立，因为我的控制器不会生成配对。（它改为调用其他API，要求该API做一些事情。）

所以这是我的问题：如何更改注释以允许我为此端点编写自定义文档？

Answer 1

您可以使用swagger_context键更改任何Swagger字段，包括description（您正在寻找的字段）：https://api-platform.com/docs/core/swagger/#changing-operations-in-the-swagger-documentation

Answer 2

它对我不起作用，这是我使用openapi_context的方法：

"openapi_context"={
    "summary"="test",
},

API平台：更改端点的描述

2 个答案: