But wait, we can do much more! Generating full API Clients
I hope that by this time you're convinced of the value of the Client 😊. The best thing about all this is that everything is a text file, so I can put my request file with its config in a folder in my repository, pushes it to my repository together with my source files and I suddenly have an easy way to interact with my API. Running the request with the slug set to ispum returns a valid response Running the request gets me the response, as expected, and it's even saved in a log file for me. You can either create a public file, or a private one for, say, API Keys. Pick an environment, and fill in a value for the variables you need. The one thing that I want to show you here is that it defines variables for you that you can fill in using a separate configuration file. You can do many things with those requests, like setting Content-Type, sending body payload and more but I'll direct you to the documentation for more. When clicking it, it will generate a scratch file for this request : The generated request The "Open in HTTP Client" option in the gutter of our IDE For example, looking at this Spring Boot Kotlin Sample, next to each Mapping there is a "Open in HTTP Client" option in the gutter. One thing I love about it is that it's integrated into the IDE, and it can generate those requests for you. Let's dive into how! A quick introduction to the Jetbrains HTTP ClientĪ lot of people don't know about the Jetbrains HTTP Client, which is a Jetbrains proprietary text file format that allows you to run API requests easily. With a combination of the Jetbrains HTTP Client and OpenAPI generators we can do much better, in a semi automated way and even reuse our code on our CI/CD. But I don't quite like the product any more, and it forces me to move out of my IntelliJ environment which really kills my productivity. Most people I know tend to use Postman for this. I work a lot with APIs, whether for an app I develop myself, or to interact with others. TL DR : I've created the first version of an openapi-generator for the jetbrains HTTP Client, and together with the CLI runner it allows you to play against APIs without ever going out of your terminal and it can even run in your CI/CD pipeline.
0 kommentar(er)
