Book Image

Building Distributed Applications in Gin

By : Mohamed Labouardy
4 (1)
Book Image

Building Distributed Applications in Gin

4 (1)
By: Mohamed Labouardy

Overview of this book

Gin is a high-performance HTTP web framework used to build web applications and microservices in Go. This book is designed to teach you the ins and outs of the Gin framework with the help of practical examples. You’ll start by exploring the basics of the Gin framework, before progressing to build a real-world RESTful API. Along the way, you’ll learn how to write custom middleware and understand the routing mechanism, as well as how to bind user data and validate incoming HTTP requests. The book also demonstrates how to store and retrieve data at scale with a NoSQL database such as MongoDB, and how to implement a caching layer with Redis. Next, you’ll understand how to secure and test your API endpoints with authentication protocols such as OAuth 2 and JWT. Later chapters will guide you through rendering HTML templates on the server-side and building a frontend application with the React web framework to consume API responses. Finally, you’ll deploy your application on Amazon Web Services (AWS) and learn how to automate the deployment process with a continuous integration and continuous delivery (CI/CD) pipeline. By the end of this Gin book, you will be able to design, build, and deploy a production-ready distributed application from scratch using the Gin framework.
Table of Contents (16 chapters)
1
Section 1: Inside the Gin Framework
3
Section 2: Distributed Microservices
9
Section 3: Beyond the Basics

Writing the OpenAPI Specification

The OpenAPI Specification (formerly known as the Swagger Specification) is an API description format or API definition language. It allows you to describe an API, including the following information:

  • General information about the API
  • The available paths and operations (HTTP methods)
  • The expected inputs (query or path parameters, request body, and so on) and responses (HTTP status code, response body, and so on) for each operation

Finding an easy way to generate the OpenAPI definition from an existing API can be challenging. The good news is that Swagger tools can help you do this with ease.

Installing Go Swagger

To get started, install the go-swagger tool from the official guide at https://goswagger.io/install.html or download the binary from GitHub at https://github.com/go-swagger/go-swagger/releases. At the time of writing this book, the latest stable version is v0.25.0:

Figure 2.21 – Go Swagger...