moduledoc

package
v0.0.0-...-e3d98aa Latest Latest
Warning

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

Go to latest
Published: Aug 6, 2020 License: MIT Imports: 10 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// MethodGet is GET
	MethodGet = "GET"
	// MethodPost is POST
	MethodPost = "POST"
	// MethodPut is PATCH
	MethodPut = "PUT"
	// MethodPatch is PATCH
	MethodPatch = "PATCH"
	// MethodDelete is DELETE
	MethodDelete = "DELETE"
	// MethodHead is DELETE
	MethodHead = "HEAD"
	// MethodOptions is DELETE
	MethodOptions = "OPTIONS"
	// MethodTrace is DELETE
	MethodTrace = "TRACE"
)
View Source
const (
	// MimeTypeApplicationJSON is standard JSON-based Content-type
	MimeTypeApplicationJSON = "application/json"
	// MimeTypeGDriveFolder is standard to create new folder on Google Drive
	MimeTypeGDriveFolder = "application/vnd.google-apps.folder"
	// MimeTypeGDriveUploadFile is standard to upload file on Google Drive
	MimeTypeGDriveUploadFile = "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
)
View Source
const (
	// FieldOptional is optional
	FieldOptional = "Optional"
	// FieldRequired is required
	FieldRequired = "Required"
)

Variables

This section is empty.

Functions

func ReadDocTemplate

func ReadDocTemplate(path string) (*document.Document, error)

ReadDocTemplate to use existing document template

func ReadOpenAPI

func ReadOpenAPI(path string) (*openapi3.Swagger, error)

ReadOpenAPI to read OpenAPI spec

Types

type DocRepository

type DocRepository interface {
	BuildFrontpage()
	BuildTOC()
	BuildPaths()
}

DocRepository list out available function

func NewDocumentHandler

func NewDocumentHandler(doc *document.Document, swagger *openapi3.Swagger) DocRepository

NewDocumentHandler works as a handler to use document module

Jump to

Keyboard shortcuts

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