Skip to content
GitLab

Add a new jetbrains http client generator

Merged Administrator requested to merge github/fork/jlengrand/feat/jetbrains-http-client into master

Created by: jlengrand

This PR is currently a WIP, in order to get feedback on it.

This PR adds (basic) support for the Jetbrains HTTP Client. I intend, with your permission, to be the owner of that generator in the future.

For a given OpenAPI file, the current generator creates a HTTP request for each endpoint, with variable parameters where necessary. It also supports Content-Type headers.

For the 3.0 Petstore, you can find the generated README as well as one of the generated API Files.

This PR currently lacks tests, and I also want to add minimal support for additional headers as well before it gets merged.

With the newly released Jetbrains HTTP Client CLI, I believe this generator can be useful to quickly generate full testing landscape for project APIs, and potentially include them as part of automated CI as well. You can find a list of features that I want to add in the longer run over here.

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 (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.