docs

package
v1.7.0 Latest Latest
Warning

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

 Go to latest Published: Feb 25, 2024 License: MIT Imports: 1 Imported by: 0

README

API Documentation

Build the documentation

Run:

	$ ./build-doc-swagger.sh

or

	$ swag init

Then:

	$ go build

View web api documentation

Try url:

	http://localhost:8080/swagger/index.html

Documentation

Overview

Package docs GENERATED BY SWAG; DO NOT EDIT This file was generated by swaggo/swag

Index

Constants

This section is empty.

Variables

View Source 
var SwaggerInfo = &swag.Spec{
	Version:          "1.0",
	Host:             "127.0.0.1:8080",
	BasePath:         "/",
	Schemes:          []string{},
	Title:            "MiniStream API",
	Description:      "This documentation describes MiniStream API",
	InfoInstanceName: "swagger",
	SwaggerTemplate:  docTemplate,
}

SwaggerInfo holds exported Swagger Info so clients can modify it

Functions

This section is empty.

Types

This section is empty.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.