问题如下:我有一个 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",
* )
* )
*/
最后两个响应可以声明给我当然要避免的所有端点