openapi-generator/samples/client/petstore/jetbrains/http/client

OpenAPI Petstore - Jetbrains API Client

General API description

This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.

• API basepath : http://petstore.swagger.io/v2
• Version : 1.0.0

Documentation for API Endpoints

All URIs are relative to http://petstore.swagger.io/v2, 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
PetApi	addPet	POST /pet	Add a new pet to the store
PetApi	deletePet	DELETE /pet/{petId}	Deletes a pet
PetApi	findPetsByStatus	GET /pet/findByStatus	Finds Pets by status
PetApi	findPetsByTags	GET /pet/findByTags	Finds Pets by tags
PetApi	getPetById	GET /pet/{petId}	Find pet by ID
PetApi	updatePet	PUT /pet	Update an existing pet
PetApi	updatePetWithForm	POST /pet/{petId}	Updates a pet in the store with form data
PetApi	uploadFile	POST /pet/{petId}/uploadImage	uploads an image
StoreApi	deleteOrder	DELETE /store/order/{orderId}	Delete purchase order by ID
StoreApi	getInventory	GET /store/inventory	Returns pet inventories by status
StoreApi	getOrderById	GET /store/order/{orderId}	Find purchase order by ID
StoreApi	placeOrder	POST /store/order	Place an order for a pet
UserApi	createUser	POST /user	Create user
UserApi	createUsersWithArrayInput	POST /user/createWithArray	Creates list of users with given input array
UserApi	createUsersWithListInput	POST /user/createWithList	Creates list of users with given input array
UserApi	deleteUser	DELETE /user/{username}	Delete user
UserApi	getUserByName	GET /user/{username}	Get user by user name
UserApi	loginUser	GET /user/login	Logs user into the system
UserApi	logoutUser	GET /user/logout	Logs out current logged in user session
UserApi	updateUser	PUT /user/{username}	Updated user

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