我已经使用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 Platform生成的文档现在不准确。它说：
/devices/pairing创建配对资源。
......这不再是真的，因为我的控制器没有生成配对。（它调用了不同的API，要求该API做一些事情。）
所以我的问题是：如何更改注解以允许我为此端点编写自定义文档？
2条答案
按热度按时间jtoj6r0c1#
适用于ApiPlatform〉2.6
您需要使用
ApiPlatform\Metadata\ApiProperty，如下所示https://api-platform.com/docs/core/openapi/#using-the-openapi-and-swagger-contexts适用于ApiPlatform〈= 2.6
它对我不起作用，下面是我如何使用openapi_context：
7qhs6swi2#
您可以使用
swagger_context键更改任何“摆动”字段，包括description（您正在查找的字段）：https://api-platform.com/docs/core/swagger/#changing-operations-in-the-swagger-documentation