Documentation

Overview

    package swagger auto serve open api doc with swagger 2.0 annotations

    Index

    Constants

    View Source
    const (
    	// Profile is the configuration name "swagger"
    	Profile = "swagger"
    )

    Variables

    This section is empty.

    Functions

    This section is empty.

    Types

    type ApiInfoBuilderInterface

    type ApiInfoBuilderInterface interface {
    	Title(value string) ApiInfoBuilderInterface
    	Description(value string) ApiInfoBuilderInterface
    	TermsOfServiceUrl(value string) ApiInfoBuilderInterface
    	Version(value string) ApiInfoBuilderInterface
    	ContactName(value string) ApiInfoBuilderInterface
    	ContactEmail(value string) ApiInfoBuilderInterface
    	ContactURL(value string) ApiInfoBuilderInterface
    	Contact(value Contact) ApiInfoBuilderInterface
    	LicenseName(value string) ApiInfoBuilderInterface
    	LicenseURL(value string) ApiInfoBuilderInterface
    	License(value License) ApiInfoBuilderInterface
    	Schemes(values ...string) ApiInfoBuilderInterface
    	Host(values string) ApiInfoBuilderInterface
    	BasePath(values string) ApiInfoBuilderInterface
    }

    func ApiInfoBuilder

    func ApiInfoBuilder() ApiInfoBuilderInterface

    type Contact

    type Contact struct {
    	Name  string `json:"name,omitempty"`
    	URL   string `json:"url,omitempty"`
    	Email string `json:"email,omitempty"`
    }

    type HttpMethod

    type HttpMethod interface {
    	GetMethod() string
    	GetPath() string
    }

    type License

    type License struct {
    	Name string `json:"name,omitempty"`
    	URL  string `json:"url,omitempty"`
    }