httpswagger

README

http-swagger

Default net/http wrapper to automatically generate RESTful API documentation with Swagger 2.0.

Usage

Start using it

1. Add comments to your API source code, See Declarative Comments Format.
2. Download Swag for Go by using:

$ go get github.com/swaggo/swag/cmd/swag

1. Run the Swag in your Go project root folder which contains main.go file, Swag will parse comments and generate required files(docs folder and docs/doc.go).

$ swag init

4.Download http-swagger by using:

$ go get -u github.com/swaggo/http-swagger

And import following in your code:

import "github.com/swaggo/http-swagger" // http-swagger middleware

Canonical example:

package main

import (
	"net/http"

	"github.com/go-chi/chi"
	"github.com/swaggo/http-swagger"
	_ "github.com/swaggo/http-swagger/example/go-chi/docs" // docs is generated by Swag CLI, you have to import it.
)

// @title Swagger Example API
// @version 1.0
// @description This is a sample server Petstore server.
// @termsOfService http://swagger.io/terms/

// @contact.name API Support
// @contact.url http://www.swagger.io/support
// @contact.email support@swagger.io

// @license.name Apache 2.0
// @license.url http://www.apache.org/licenses/LICENSE-2.0.html

// @host petstore.swagger.io
// @BasePath /v2
func main() {
	r := chi.NewRouter()

	r.Get("/swagger/*", httpSwagger.Handler(
		httpSwagger.URL("http://localhost:1323/swagger/doc.json"), //The url pointing to API definition"
	))

	http.ListenAndServe(":1323", r)
}

1. Run it, and browser to http://localhost:1323/swagger/index.html, you can see Swagger 2.0 Api documents.

Documentation

Index

• Variables
• func DeepLinking(deepLinking bool) func(c *Config)
• func DocExpansion(docExpansion string) func(c *Config)
• func DomID(domID string) func(c *Config)
• func Handler(configFns ...func(*Config)) http.HandlerFunc
• func PersistAuth(persistAuth bool) func(c *Config)
• func URL(url string) func(c *Config)
• type Config

Variables

var WrapHandler = Handler()

WrapHandler wraps swaggerFiles.Handler and returns http.HandlerFunc

Functions

func DeepLinking

func DeepLinking(deepLinking bool) func(c *Config)

DeepLinking true, false

func DocExpansion

func DocExpansion(docExpansion string) func(c *Config)

DocExpansion list, full, none

func DomID

func DomID(domID string) func(c *Config)

DomID #swagger-ui

func Handler

func Handler(configFns ...func(*Config)) http.HandlerFunc

Handler wraps `http.Handler` into `http.HandlerFunc`.

func PersistAuth

func PersistAuth(persistAuth bool) func(c *Config)

PersistAuth true, false

func URL

func URL(url string) func(c *Config)

URL presents the url pointing to API definition (normally swagger.json or swagger.yaml).

Types

type Config

type Config struct {
	//The url pointing to API definition (normally swagger.json or swagger.yaml). Default is `doc.json`.
	URL          string
	DeepLinking  bool
	DocExpansion string
	DomID        string
	PersistAuth  bool
}

Config stores httpSwagger configuration variables.