Adding README file

This commit is contained in:
Julien Lengrand-Lambert
2024-03-07 16:55:19 +01:00
parent 6e94cbbad2
commit 1a63833e9b
3 changed files with 28 additions and 0 deletions

28
README.md Normal file
View File

@@ -0,0 +1,28 @@
# Jetbrains Client API directory
This repository is a collection of [OpenAPI](https://swagger.io/specification/) specification files that have been converted into the [Jetbrains HTTP Client](https://www.jetbrains.com/help/idea/http-client-reference.html) format and are ready for use.
It's basically Postman, within IntelliJ, ready for you to use.
Each folder contains a different API. To use them, open them up in [IntelliJ](https://www.jetbrains.com/idea/), and run them 😊.
![http_request_demo.gif](assets/http_request_demo.gif)
## APIs
* [GitHub](/apis/github/README.md)
* [Fly.io](/apis/flyio/README.md)
* [OpenAQ](/apis/openaq/README.md)
## Authenticated calls and parameters
* In the files, you will find values looking like this ``{{parameter}}``. Those parameters can be set using an environment file.
* In many cases, an API Key is also required. The method is the same.
* Set the environment you want to run the query in, and run the query!
![environment.gif](assets/environment.gif)
_Note: Never upload your private environment files with your API Keys. They should be ignored by default._
## Author
* [Julien Lengrand-Lambert](https://github.com/jlengrand)

BIN
assets/environment.gif Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.4 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.2 MiB