Book Image

Building RESTful Web services with Go

By : Naren Yellavula
Book Image

Building RESTful Web services with Go

By: Naren Yellavula

Overview of this book

REST is an architectural style that tackles the challenges of building scalable web services and in today's connected world, APIs have taken a central role on the web. APIs provide the fabric through which systems interact, and REST has become synonymous with APIs. The depth, breadth, and ease of use of Go, makes it a breeze for developers to work with it to build robust Web APIs. This book takes you through the design of RESTful web services and leverages a framework like Gin to implement these services. The book starts with a brief introduction to REST API development and how it transformed the modern web. You will learn how to handle routing and authentication of web services along with working with middleware for internal service. The book explains how to use Go frameworks to build RESTful web services and work with MongoDB to create REST API. You will learn how to integrate Postgres SQL and JSON with a Go web service and build a client library in Go for consuming REST API. You will learn how to scale APIs using the microservice architecture and deploy the REST APIs using Nginx as a proxy server. Finally you will learn how to metricize a REST API using an API Gateway. By the end of the book you will be proficient in building RESTful APIs in Go.
Table of Contents (20 chapters)
Title Page
Credits
About the Author
Acknowledgments
About the Reviewer
www.PacktPub.com
Customer Feedback
Preface

Building a Metro Rail API with go-restful


Let us use the knowledge we gained in the previous section and create an API for the City Metro Rail project we talked about in the preceding section. The roadmap is as follows:

  1.  Design a REST API document.
  2.  Create models for a database.
  3.  Implement the API logic.

Design specification

Before creating any API, we should know what the specifications of APIs are in the form of a document. We showed a few examples in the previous chapters, including the URL shortener API design document. Let us try to create one for this Metro Rail project. Take a look at the following table:

HTTP verb

Path

Action

Resource

POST

/v1/train (details as JSON body)

Create

Train

POST

/v1/station (details as JSON body)

Create

Station

GET

/v1/train/id 

Read

Train

GET

/v1/station/id

Read

Station

POST

/v1/schedule (source and destination)

Create

Route

 

We can also include the UPDATE and DELETE methods. By implementing the preceding design, it will be obvious for users to implement them on their own.

Creating...