Using Swagger for REST API Documentation

Let’s learn how to use Swagger for REST API documentation.

We'll cover the following

Using go-swagger
Documenting the REST API
Generating the documentation file
Serving the documentation file
- Let’s try our command

In this lesson, we’ll discuss the documentation of a REST API. We are going to use the OpenAPI Specification for documenting the REST API. The OpenAPI Specification, which is also called the Swagger Specification, is a specification for describing, producing, consuming, and visualizing RESTful web services.

Put simply, Swagger is a representation of our RESTful API. Swagger reads the appropriate code annotations and creates the OpenAPI file. To be able to document a REST API using Swagger, we basically have two choices. First, writing the OpenAPI Specification file on our own (manually), or adding annotations in the source code that help Swagger generate the OpenAPI Specification file for us (automatically).

Get hands-on with 1400+ tech skills courses.

Course Introduction

Introduction to Go

Basic Go Data Types

Composite Data Types

Reflection and Interfaces

Go Packages and Functions

Telling a UNIX System What to Do

Go Concurrency

Building Web Services

Working with TCP/IP and WebSocket

Working with REST APIs

Code Testing and Profiling

Working with gRPC

Go Generics

Conclusion

Appendix A—Go Garbage Collector

Using Swagger for REST API Documentation