httpSwagger

package module
Version: v1.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 17, 2021 License: MIT Imports: 7 Imported by: 2

README

httptreemux-swagger

github.com/dimfeld/httptreemux 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 httptreemux-swagger by using:

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

And import following in your code:

import "github.com/swaggo/httptreemux-swagger" // httptreemux-swagger middleware
Canonical example:
package main

import (
	"net/http"

	"github.com/go-chi/chi"
	"github.com/swaggo/httptreemux-swagger"
	_ "github.com/swaggo/httptreemux-swagger/example/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.

swagger_index.html

Documentation

Index

Constants

This section is empty.

Variables

View Source
var WrapHandler = Handler()

WrapHandler wraps swaggerFiles.Handler and returns httptreemux.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)) httptreemux.HandlerFunc

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

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
}

Config stores httpSwagger configuration variables.

Source Files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL