Added implicit headers property to TypeScriptAxiosClientCodegen (!11188) · Merge requests · OpenAPI Tools / openapi-generator

Open Administrator requested to merge github/fork/chrispaynter/add-implicit-headers-to-ts-axios into master Dec 27, 2021

Created by: chrispaynter

When generating a Typescript Axios client, by default all header params are being added as method parameters for each API endpoint.

This causes a problematic developer experience, as you have to continuously pass through header values that should be able to be configured at the HTTP client level (sdk keys, other special custom headers).

Taking inspiration from the Spring code gen, I've added an implicit headers property to the code gen for Typescript Axios - TypeScriptAxiosClientCodegen.java

The prop can be used as such:

java -jar openapi-generator-cli.jar generate -i swagger.json -g typescript-axios -o dist --additional-properties implicitHeaders=true

I'm not a Java guy, so did my best by following the existing Spring code generator file.

Companion PR to - https://github.com/OpenAPITools/openapi-generator/issues/11187

@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)

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
```
Commit all changed files. This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master. These must match the expectations made by your contribution. You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./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 (5.3.0), 6.0.x
If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.