Check out this open-source project to start learning how to manage modern APIs with protobuf and OpenAPI

I am a tech-enthusiast, and I love sharing new technologies, ideas, and innovations about software development. This time, I will be talking about API contract management with Protobuf and OpenAPI.

One of the most important aspects of microservices-based applications is the ability to deploy microservices completely independent of one another. To achieve this independence, each microservice must provide a versioned, well-defined contract to its clients. Each service must not break contracts until it’s known that no other microservice relies on a particular contract version.

In this post, I am going to present a project containing patterns, tools, and technologies used to develop contract-based APIs which will help teams communicate and ensure compatibility.

Bootstrapping a Modern API

The idea of this project is to provide you with a bootstrap for your next API based project(e.g microservices). We are addressing some of the main challenges that everyone faces when starting with this type of project. This project will definitely help you get an understanding of the API lifecycle and save you a lot of time when setting up your initial API architecture.

In this blog post, I will walk through some concepts and technologies that we have placed in our bootstrap modern API management project. I’m not planning on going very deep into the concepts and tools — we have a lot of posts about those out there — the intention here is to present an application example containing everything when developing contract-based APIs.

This  project tries to provide a modern approach to manage APIs, combining the Protobuf and OpenAPI specifications.

The project tries to solve the following challenges:

• Contract definitions
• Contract compatibility enforcement
• Contract versioning
• OpenAPI definition generation
• Stub generation to different languages (Java and Golang)
• Client SDK generation to different languages(Java and Golang)
• Web UI for manual test
• API interactive documentation
• API management guideline
• ETC

#integration #microservices #rest #openapi