Support with OAUTH1 and OAUTH 2 authentication

[jsanjay63]

Hi,
First of all, thanks for developing this python client. This seems to be very much helpful.

I would like to know if openapi-python-client supports generating clients for Open API spec with OAUTH 1 authentication?
If yes, could someone please help with the related docs?

Thanks,
Sanjay

[dbanty]

Hey Sanjay 👋. There aren't any features that do oauth-specific things (yet). As far as auth, the only thing generated clients will have is an AuthenticatedClient which has a token attribute. Using that client will put a header in your requests like "Authorization": f"Bearer {token}" which is pretty standard in OAuth, but not guaranteed to be what your service uses. You can also set headers and cookies yourself for whatever your service uses.

It would certainly be nice for us to generate more helpful code around OAuth, but I haven't yet figured out an ergonomic way to do that. If you have suggestions, I'd love to hear it!

[jsanjay63]

Hey Dylan,
Thanks for the update. Yes, correct I was looking for some more helpful code with OAuth such that I can pass the OAuth consumer keys and secrets. Headers and cookies could work for now though.
Another thing I am interested in is to set the default base URL for the client from the spec. I couldn't find an example related to this. Could you please help with some docs?
Also, I observed in cases where the URL accepts path parameters eg: /resources/{xyz}/apis, it uses only the base URL to format but doesn't allow to update the path parameter value. The client code generated looks like:
url = "{}/resources/{xyz}/apis".format(client.base_url)
as {xyz} won't be part of the base URL, it throws an error.

[dbanty]

The generated client doesn't do anything with the servers section of the OpenAPI document yet, so it doesn't include any base URLs in the generated code. There's a request to implement that at #112 with a bit of design discussion if you want to add your opinion.

Not replacing path parameters is definitely a bug (this used to work for sure!), could you open an issue with the bug template and provide the spec which didn't work?

[jsanjay63]

@dbanty Happy new year. Sorry for the delay. Just to update, replacing path parameters isn't a bug, issue was with the spec version. I was trying with swagger 2.0 version. Thanks.

[dbanty]

Awesome, thanks for getting back to me. Happy New Year! 🎉

[jsanjay63]

@dbanty I would like to know if it's possible to add custom headers to the request in the generated client?

[emann]

@jsanjay63 You can either provide headers as a parameter when you make an instance of either Client or AuthenticatedClient:

from my_api_client import Client
api_client = Client(base_url="http://localhost:1234", headers={"my": "headers"})

or you can "evolve" the client on a per-request basis:

from my_api_client import Client
from my_api_client.api.default import an_endpoint

api_client = Client(base_url="http://localhost:1234")
an_endpoint.sync(client=api_client.with_headers({"my_headers": "for_just_this_one_request"})