Categorygithub.com/teambition/swaggo
modulepackage
0.0.0-20181122092339-d7095f9f4471
Repository: https://github.com/teambition/swaggo.git
Documentation: pkg.go.dev

# README

Swaggo - v0.2.8

Parse annotations from Go code and generate Swagger Documentation

Build Status Coverage Status License

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

# Packages

No description provided by the author
No description provided by the author
@Version 1.0.0 @Title Swagger Example API @Description Swagger Example API @Host 127.0.0.1:3000 @BasePath /api @Name swagger @Contact [email protected] @URL teambition.com @TermsOfServiceUrl http://teambition.com/ @License Apache @LicenseUrl http://teambition.com/ @Schemes http,wss @Consumes json,plain,xml,html @Produces json,plain,xml,html.