Question

问题如下：我有一个API，当然每个端点都有一个特定类型的响应，以便成功调用。但是当发生错误时，所有端点都会有相同的响应。例如，当请求包含无效参数时，每个端点都返回400状态代码，其中包含描述问题的特定内容。对于身份验证或授权问题也是如此。我试图将共享响应放到应用程序的入口点，它们位于生成的swagger.json中，但它们与端点无关。我希望所有端点都包含所有共享响应及其特定响应。我可以通过简单地解析json并通过脚本添加响应来实现它，但我必须有更好的方法来执行此操作。

以下是一个示例动作文档，以防万一：

/**
 * @SWG\Post(
 *     path="/integration/create",
 *     description="Creates the given integration",
 *     @SWG\Parameter(
 *         name="body",
 *         in="body",
 *         required=true,
 *         @SWG\Schema(ref="#/definitions/IntegrationCreateRequest"),
 *     ),
 *     @SWG\Response(
 *         response="204",
 *         description="Successful creation",
 *     ),
 *     @SWG\Response(
 *         response="400",
 *         description="Invalid request parameters",
 *         @SWG\Schema(ref="#/definitions/InvalidRequestResponse"),
 *     ),
 *     @SWG\Response(
 *         response="401",
 *         description="Unauthenticated request",
 *     )
 * )
 */

最后两个响应可以向所有端点声明我当然要避免的

Swagger PHP共享响应

0 个答案: