specs

package

v0.0.0-...-b3e4aef Latest Latest Go to latest Published: Oct 21, 2024 License: MIT Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

type API struct {
	// contains filtered or unexported fields
}

func New(options ...Option) (*API, error)

func (api *API) Json() string

func (api *API) WithOptions(opts ...Option) *API

type Option interface {
	// contains filtered or unexported methods
}

func WithComponents(keyAndValues ...interface{}) Option

func WithContact(name string, url string, email string) Option

func WithDescription(description oas.RichText) Option

func WithExternalDocs(description oas.RichText, url string) Option

func WithLicense(name string, url string) Option

func WithOperation(id string, method string, path string, opts ...operation.Option) Option

func WithSchemaDefinitions(definitions map[string]*oas.Schema) Option

func WithSecurity(requirements ...oas.SecurityRequirement) Option

func WithServer(protocol, hostname string, port uint16, pathname string, opts ...server.Option) Option

func WithTOS(url string) Option

func WithTag(name string, description oas.RichText) Option

func WithTitle(title string) Option

func WithVersion(version string) Option

func WithWebhook(name string, method string, opts ...operation.Option) Option