swaggo

README

Swaggo - v0.2.8

Parse annotations from Go code and generate Swagger Documentation

• 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

Documentation

Overview

convert comments to swagger-api-doc just support swagger-2.0