Created by: stropho
There are several generated entities that can be used to create a request. The commonly used are the generated: class
or api factory
. Both of these entities use an FP
entity internally - let's call it a lower layer used to accomplish a request; we don't need to go deeper than that.
Current behaviour for api factory
: FP is created once for all the request (within a single factory product). Example from https://github.com/OpenAPITools/openapi-generator/blob/d8bed4228d8b0aa5e5f0c12b4485d20c7310505c/samples/client/petstore/typescript-axios/builds/default/api.ts#L714
export const PetApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
const localVarFp = PetApiFp(configuration)
return {
/**
*
* @summary Add a new pet to the store
* @param {Pet} body Pet object that needs to be added to the store
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
addPet(body: Pet, options?: any): AxiosPromise<void> {
return localVarFp.addPet(body, options).then((request) => request(axios, basePath));
},
}
Current behaviour for a class
: FP is created for every request. Example from https://github.com/OpenAPITools/openapi-generator/blob/d8bed4228d8b0aa5e5f0c12b4485d20c7310505c/samples/client/petstore/typescript-axios/builds/default/api.ts#L821
export class PetApi extends BaseAPI {
/**
*
* @summary Add a new pet to the store
* @param {Pet} body Pet object that needs to be added to the store
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof PetApi
*/
public addPet(body: Pet, options?: AxiosRequestConfig) {
return PetApiFp(this.configuration).addPet(body, options).then((request) => request(this.axios, this.basePath));
}
}
This PR enforces the objects (class instances) to use a signle FP entity.
PR checklist
-
Read the contribution guidelines. -
Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community. -
Run the following to build the project and update samples: ./mvnw clean package ./bin/generate-samples.sh ./bin/utils/export_docs_generators.sh
./bin/generate-samples.sh bin/configs/java*
. For Windows users, please run the script in Git BASH. -
File the PR against the correct branch: master
(6.3.0) (minor release - breaking changes with fallbacks),7.0.x
(breaking changes without fallbacks) -
If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.
@TiFu (2017/07) @taxpon (2017/07) @sebastianhaas (2017/07) @kenisteward (2017/07) @Vrolijkx (2017/09) @macjohnny (2018/01) @topce (2018/10) @akehir (2019/07) @petejohansonxo (2019/11) @amakhrov (2020/02) @davidgamero (2022/03) @mkusaka (2022/04)