OpenApi Usage Example

This repository contains the codebase that was used in the article How to Write a Robust REST API with OpenAPI in the blog yonatankarp.com.

How to run

To build the project using Gradle run the following command in the project root directory:

$ ./gradlew build

Once the project was successfully build, run the service with the following command:

$ ./gradlew bootRun

When the service runs, you can call it with the following example:

$ curl "http://localhost:8080/v1/greet?name=Yonatan"

Response example:

{"greet":"Hello, yonatan!"}

Built With

• OpenJdk 17
• Kotlin
• OpenAPI - API Spec
• SpringBoot 3.x.x - The web framework used
• Gradle Kotlin DSL - Dependency Management

Authors

• Yonatan Karp-Rudin - Initial work - yonatankarp