content returned as bytes instead of native python objects?

[pll]

Hi,

I'm just digging into openapi-python-client and trying to use it to generate client code to interact with a Spring-boot based service. Since the Spring-boot project uses openapi and has a spec file, I was able to quickly generate the client code, and after a bit of trial-and-error actually get a response from the service (so, very cool!). However, when I make the API call using the generated client code, the content is returned as a string.

Since the service returns JSON, it seems a little cumbersome to have to do this all the time:

Model = PodDTO(name="foo")
Response = my_model.sync_detailed(client=client, pageable = Model)
content = json.loads(Response.content)

Am I better off modifying the Responses class in the generated client/types.py ? Or am I better off wrapping the generated module and modifying return values there? If I modify the code openapi-python-client generates, I'm concerned about losing those mods if later on if the openapi.yml and I need to re-generate the python client code.

So what's the best approach here? Modifying the generated client code? Or wrapping that code and making modifications to the return values in the wrapping class ?

Thanks!

Paul

[dbanty]

If the return type is properly documented in the OpenAPI spec for the API, then there should be a Response.parsed field with the data deserialized already. You can also access this faster by calling the sync() method in the API module instead of sync_detailed() (if you don't need anything else on the Response object).

If the response type is not documented in the OpenAPI spec, then openapi-python-client has no way of knowing how to deserialize it, so you'll have to do it yourself. Your best bet might be to add a preprocessor to modify the openapi.yml before running the generator to insert the appropriate OpenAPI types.

[pll]

Thanks, I'll go looking for that. I did discover that the Response object actually has a Response.content_json() method in addition to the response.content(), so I started using that instead of calling json.loads() on my own. I'm not sure if the content_json() call is equivalent to the .parsed field you refer to, but provided by this API instead. Or if it the Response object should ALSO have a .parsed field in addition to the .content_json() method.

Anyway, this is at least another thread I can go pulling on to see what happens :)

Thanks again!

Paul