Handling Error Responses in API with OpenAPI Specification about openapi-ts HOT 14 OPEN

@IgorKha fastapi/fastapi#11882 (comment)

from openapi-ts.

@IgorKha feel free to propose a different implementation!

from openapi-ts.

Yes @sagardwivedi, but that is a FastAPI question. Had the OpenAPI specification been correct, then it would be an issue with this package

from openapi-ts.

Okay, I will raise the question with FastAPI. @mrlubos, thank you for your response!

from openapi-ts.

Should I close the issue here?

from openapi-ts.

I am trying to custom set the error message if i get the response 400

if (response.status === 400) {
      return setError(error?.detail)
}

but i am getting (property) detail?: ValidationError[] | undefined in error?.detail
but I am getting from the backend

from openapi-ts.

It doesn't matter what is returned from the backend. OpenAPI specification is the contract describing the API. It's up to the server to then value that contract. In your case, there are scenarios you're not describing in the contract as you can see from your spec

from openapi-ts.

same problem....
@sagardwivedi Will you bring up the FastAPI issue? Please provide a link

from openapi-ts.

I think it would be correct to always return the server's response status code in the case of an error. This makes more sense, as it provides the actual response status from the server.

from openapi-ts.

@IgorKha I understand your point, but after thoroughly checking the FastAPI documentation, I couldn't find an alternative method. The @hey-api/openapi-ts library relies on openapi.json to generate client, and unfortunately, the openapi.json doesn't include the raise HTTPException.

from openapi-ts.

Yes, I understand; I read the discussion about FastAPI. I realize this is an issue specific to their implementation. However, I would still like to ask the author of this library to consider providing an option to return the actual server response status code in case of an error, regardless of what's in the OpenAPI specification. In my opinion, this would be quite versatile and convenient for everyone.
Thank you :)

from openapi-ts.

@IgorKha if you're using the new standalone client packages, you have access to the raw response object. Is that what you need?

from openapi-ts.

I use @hey-api/client-axios, but I also tested @hey-api/client-fetch. Indeed, the raw response contains the server status, but the issue is that you have to remember this additional step while working. This workaround does address the problem, though it's not as native as I'd like. It seems I'll have to adjust the backend 🥲

Anyway, thank you for the great tool! 😄

from openapi-ts.

FastAPI actually provides a solution to this in the documentation. When you set a responses parameter in your path operation decorators, the other response codes will show up in the OpenAPI spec and openapi-ts will capture them.

from openapi-ts.