julien Lengrand-Lambert 42c78403cb
JetBrains HTTP Client - Adds support for query and header params and env file (#18844)
* Adds basic support for query params.

* Need to parameterize them
* Need to add tests
* Need to add option to skip, maybe
* Need to add support for header params too

* Parameterizes query param values

* Need to add tests
* Need to add option to skip, maybe
* Need to add support for header params too

* Remove extra empty line

* Adds support for header params

* Also fixes extra end of line bug.

* Fixing failing test

* Adding tests for query params

* Adding tests for header params

* Adding basic support for env file

* Add support for env file for path variables and custom header variables

* TODO : Add tests

* Adding tests for env generation

* Adding generated test files

* Fix namefile
2024-06-05 10:30:25 +08:00
..

Checkout Basic - Jetbrains API Client

General API description

Checkout Basic

Documentation for API Endpoints

All URIs are relative to https://checkout-test.adyen.com/v71, but will link to the .http file that contains the endpoint definition. There may be multiple requests for a single endpoint, one for each example described in the OpenAPI specification.

Class Method HTTP request Description
PaymentsApi getPaymentMethodById GET /paymentMethods/{id} Get payment method by id
PaymentsApi getPaymentMethods GET /paymentMethods Get payment methods
PaymentsApi postMakePayment POST /payments Make a payment

Usage

Prerequisites

You need IntelliJ to be able to run those queries. More information can be found here. You may have some luck running queries using the Code REST Client as well, but your mileage may vary.

Variables and Environment files

  • Generally speaking, you want queries to be specific using custom variables. All variables in the .http files have the `` format.
  • You can create public or private environment files to dynamically replace the variables at runtime.

Note: don't commit private environment files! They typically will contain sensitive information like API Keys.

Customizations

If you have control over the generation of the files here, there are two main things you can do

  • Select elements to replace as variables during generation. The process is case-sensitive. For example, API_KEY ->
    • For this, run the generation with the bodyVariables property, followed by a "-" separated list of variables
    • Example: --additional-properties bodyVariables=YOUR_MERCHANT_ACCOUNT-YOUR_COMPANY_ACCOUNT-YOUR_BALANCE_PLATFORM
  • Add custom headers to all requests. This can be useful for example if your specifications are missing security schemes.
    • For this, run the generation with the customHeaders property, followed by a "&" separated list of variables
    • Example : --additional-properties=customHeaders="Cookie:X-API-KEY="&"Accept-Encoding=gzip"

This client was generated by the jetbrains-http-client generator of OpenAPI Generator