swaggo icon indicating copy to clipboard operation
swaggo copied to clipboard

Convert Go annotations to Swagger Documentation (version 2.0)

Swaggo - v0.2.8

Parse annotations from Go code and generate Swagger Documentation

Build Status Coverage Status License

  • About
  • Quick Start Guide
    • Install
    • Declarative Comments Format
    • Usage
    • Kpass Example
    • TODO(In the near future)

About

Generate API documentation from annotations in Go code. It's always used for you Go server application. The swagger file accords to the Swagger Spec and displays it using Swagger UI(this project dosn't provide).

Quick Start Guide

Install

go get -u -v github.com/teambition/swaggo

Declarative Comments Format

中文

Usage

swaggo --help

Kpass Example

Kpass

TODO(In the near future)

  • [ ] Support API without Controller structure
  • [ ] Explain declarative comments format with english