Common response about egg-swagger-doc HOT 8 OPEN

from egg-swagger-doc.

I need easier solution as I have many error code and the schema is same

from egg-swagger-doc.

Can we have something like the following

In contract
ErrorResponse: {
code: { type: 'string', example: 'Error'},
message: { type: 'string' },
},

In controller
/**

• @summary 创建资源
• @router GET /resource/{id}
• @request path string *id resource id
• @request header string access_token
• @response 404 ErrorResponse {code:{example: 'NOT_FOUND'}}
• @response 403 ErrorResponse {code:{example: 'FORBIDDEN'}}
  */

we can merge {code:{example: 'NOT_FOUND'}} with ErrorResponse

from egg-swagger-doc.

from egg-swagger-doc.

@Ysj291823 Do you have plan to add this feature?

from egg-swagger-doc.

I can not add the feature,because in swagger 2.0 ,the response is like this

        200:
          description: "successful operation"
          schema:
            $ref: "#/definitions/Pet"
        400:
          description: "Invalid ID supplied"
        404:
          description: "Pet not found"

from egg-swagger-doc.

It is a solution :
ErrorResponse is a contract , we can generate ErrorResponse_random and use $ref: "#/definitions/ErrorResponse_random"

ErrorResponse_random = merge(ErrorResponse ,FROM_DOC)

from egg-swagger-doc.

@Ysj291823 @mkc-yanshijie Reply please

from egg-swagger-doc.