Add 'injected' HTTP client option #492
Conversation
Instead of returning the entire `ApiResult` object in the request method and then returning the body in the service, the request methods will now return the response body directly. This makes it simpler to implement a request method externally.
Rather than import the request method directly, service classes will now receive it as a constructor argument and save it as a private field. This makes the constructor classes more generic and testable. To avoid breaking changes, service class instances are instantiated and exported from index.ts with PascalCase naming. This allows users to update with no changes, because the public API does not change noticeably.
If this option is used, services will be exported as uninstantiated classes that accept a method that will handle HTTP requests. The request.ts file will not be generated as it would be unecessary.
iansan5653
force-pushed
the
Add-injected-HTTP-client-option
branch
from
d00977e to
921dfeb
Compare
|
It looks like CI is failing because the snapshots have different indentation when generated on my machine. I also noticed some missing indentation in the output for a project I'm working on, so I think that may be a separate unrelated bug - maybe related to using Windows? |
|
@ferdikoomen Can you take a look at this PR? |
|
I'd appreciate some feedback from the maintainer whether this (or something similar to customize the HTTP client) is something which might make it into openapi-typescript-codegen. Been playing around with this yesterday and liked it quite a lot, but we need a functionality to intercept the HTTP calls. |
|
To give an update here: I was researching some alternatives to this tool in the meantime, and switched to |
|
Looks like this is the way to go for now: #465 (comment) |
|
@qqilihq @iansan5653 yes the comments on 456 is the way to go: #465 |
Adds a new HTTP client option
injectedwhich will not generate an HTTP client and will instead add a field to all service classes in which the consumer supplies a request method in the form(options: ApiRequestOptions) => Promise<any>. This would be the most flexible option available, as now anyone would have the power to use any request tools available. They can track and log requests, manage their own authentication, customize behavior to fit their exact needs, and inject a mock/spy method for testing.Additional changes made to facilitate this:
requestmethod exported by all HTTP clients now returns the body directly (Promise<any>) instead of an object containing the body (Promise<ApiResponse>). This makes it easier to create a method as the injected method won't have to return unnecessary information.injected, the services are exported as pre-instantiated classes already bound to the HTTP client. So in that case, this change is invisible.request.tsis not generated if HTTP client isinjected.Resolves issues:
Also may replace / affect PRs #407, #434, #489.
TODO: