Documentation
¶
Index ¶
- Constants
- func GetStaticDocFile(filename string) middleware.Responder
- type GetDocs
- type GetDocsHandler
- type GetDocsHandlerFunc
- type GetDocsNotFound
- type GetDocsOK
- type GetDocsParams
- type GetDocsSwaggerYml
- type GetDocsSwaggerYmlHandler
- type GetDocsSwaggerYmlHandlerFunc
- type GetDocsSwaggerYmlNotFound
- type GetDocsSwaggerYmlOK
- type GetDocsSwaggerYmlParams
- type GetDocsSwaggerYmlURL
- func (o *GetDocsSwaggerYmlURL) Build() (*url.URL, error)
- func (o *GetDocsSwaggerYmlURL) BuildFull(scheme, host string) (*url.URL, error)
- func (o *GetDocsSwaggerYmlURL) Must(u *url.URL, err error) *url.URL
- func (o *GetDocsSwaggerYmlURL) SetBasePath(bp string)
- func (o *GetDocsSwaggerYmlURL) String() string
- func (o *GetDocsSwaggerYmlURL) StringFull(scheme, host string) string
- func (o *GetDocsSwaggerYmlURL) WithBasePath(bp string) *GetDocsSwaggerYmlURL
- type GetDocsURL
- func (o *GetDocsURL) Build() (*url.URL, error)
- func (o *GetDocsURL) BuildFull(scheme, host string) (*url.URL, error)
- func (o *GetDocsURL) Must(u *url.URL, err error) *url.URL
- func (o *GetDocsURL) SetBasePath(bp string)
- func (o *GetDocsURL) String() string
- func (o *GetDocsURL) StringFull(scheme, host string) string
- func (o *GetDocsURL) WithBasePath(bp string) *GetDocsURL
Constants ¶
const GetDocsNotFoundCode int = 404
GetDocsNotFoundCode is the HTTP code returned for type GetDocsNotFound
const GetDocsOKCode int = 200
GetDocsOKCode is the HTTP code returned for type GetDocsOK
const GetDocsSwaggerYmlNotFoundCode int = 404
GetDocsSwaggerYmlNotFoundCode is the HTTP code returned for type GetDocsSwaggerYmlNotFound
const GetDocsSwaggerYmlOKCode int = 200
GetDocsSwaggerYmlOKCode is the HTTP code returned for type GetDocsSwaggerYmlOK
Variables ¶
This section is empty.
Functions ¶
func GetStaticDocFile ¶
func GetStaticDocFile(filename string) middleware.Responder
Types ¶
type GetDocs ¶
type GetDocs struct {
Context *middleware.Context
Handler GetDocsHandler
}
GetDocs swagger:route GET /docs InternalAPI getDocs
ReDocによるAPIドキュメントを取得する(HTML)
func NewGetDocs ¶
func NewGetDocs(ctx *middleware.Context, handler GetDocsHandler) *GetDocs
NewGetDocs creates a new http.Handler for the get docs operation
type GetDocsHandler ¶
type GetDocsHandler interface {
Handle(GetDocsParams) middleware.Responder
}
GetDocsHandler interface for that can handle valid get docs params
type GetDocsHandlerFunc ¶
type GetDocsHandlerFunc func(GetDocsParams) middleware.Responder
GetDocsHandlerFunc turns a function with the right signature into a get docs handler
func (GetDocsHandlerFunc) Handle ¶
func (fn GetDocsHandlerFunc) Handle(params GetDocsParams) middleware.Responder
Handle executing the request and returning a response
type GetDocsNotFound ¶
type GetDocsNotFound struct {
}
GetDocsNotFound ファイルが存在しない
swagger:response getDocsNotFound
func NewGetDocsNotFound ¶
func NewGetDocsNotFound() *GetDocsNotFound
NewGetDocsNotFound creates GetDocsNotFound with default headers values
func (*GetDocsNotFound) WriteResponse ¶
func (o *GetDocsNotFound) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type GetDocsOK ¶
type GetDocsOK struct {
/*
In: Body
*/
Payload string `json:"body,omitempty"`
}
GetDocsOK APIドキュメント(ReDoc)
swagger:response getDocsOK
func NewGetDocsOK ¶
func NewGetDocsOK() *GetDocsOK
NewGetDocsOK creates GetDocsOK with default headers values
func (*GetDocsOK) SetPayload ¶
SetPayload sets the payload to the get docs o k response
func (*GetDocsOK) WithPayload ¶
WithPayload adds the payload to the get docs o k response
func (*GetDocsOK) WriteResponse ¶
func (o *GetDocsOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type GetDocsParams ¶
GetDocsParams contains all the bound params for the get docs operation typically these are obtained from a http.Request
swagger:parameters GetDocs
func NewGetDocsParams ¶
func NewGetDocsParams() GetDocsParams
NewGetDocsParams creates a new GetDocsParams object with the default values initialized.
func (*GetDocsParams) BindRequest ¶
func (o *GetDocsParams) BindRequest(r *http.Request, route *middleware.MatchedRoute) error
BindRequest both binds and validates a request, it assumes that complex things implement a Validatable(strfmt.Registry) error interface for simple values it will use straight method calls
type GetDocsSwaggerYml ¶
type GetDocsSwaggerYml struct {
Context *middleware.Context
Handler GetDocsSwaggerYmlHandler
}
GetDocsSwaggerYml swagger:route GET /docs/swagger.yml InternalAPI getDocsSwaggerYml
Swaggerによるスキーマを取得する(YAML)
func NewGetDocsSwaggerYml ¶
func NewGetDocsSwaggerYml(ctx *middleware.Context, handler GetDocsSwaggerYmlHandler) *GetDocsSwaggerYml
NewGetDocsSwaggerYml creates a new http.Handler for the get docs swagger yml operation
func (*GetDocsSwaggerYml) ServeHTTP ¶
func (o *GetDocsSwaggerYml) ServeHTTP(rw http.ResponseWriter, r *http.Request)
type GetDocsSwaggerYmlHandler ¶
type GetDocsSwaggerYmlHandler interface {
Handle(GetDocsSwaggerYmlParams) middleware.Responder
}
GetDocsSwaggerYmlHandler interface for that can handle valid get docs swagger yml params
type GetDocsSwaggerYmlHandlerFunc ¶
type GetDocsSwaggerYmlHandlerFunc func(GetDocsSwaggerYmlParams) middleware.Responder
GetDocsSwaggerYmlHandlerFunc turns a function with the right signature into a get docs swagger yml handler
func (GetDocsSwaggerYmlHandlerFunc) Handle ¶
func (fn GetDocsSwaggerYmlHandlerFunc) Handle(params GetDocsSwaggerYmlParams) middleware.Responder
Handle executing the request and returning a response
type GetDocsSwaggerYmlNotFound ¶
type GetDocsSwaggerYmlNotFound struct {
}
GetDocsSwaggerYmlNotFound ファイルが存在しない
swagger:response getDocsSwaggerYmlNotFound
func NewGetDocsSwaggerYmlNotFound ¶
func NewGetDocsSwaggerYmlNotFound() *GetDocsSwaggerYmlNotFound
NewGetDocsSwaggerYmlNotFound creates GetDocsSwaggerYmlNotFound with default headers values
func (*GetDocsSwaggerYmlNotFound) WriteResponse ¶
func (o *GetDocsSwaggerYmlNotFound) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type GetDocsSwaggerYmlOK ¶
type GetDocsSwaggerYmlOK struct {
/*
In: Body
*/
Payload string `json:"body,omitempty"`
}
GetDocsSwaggerYmlOK スキーマ(Swagger)
swagger:response getDocsSwaggerYmlOK
func NewGetDocsSwaggerYmlOK ¶
func NewGetDocsSwaggerYmlOK() *GetDocsSwaggerYmlOK
NewGetDocsSwaggerYmlOK creates GetDocsSwaggerYmlOK with default headers values
func (*GetDocsSwaggerYmlOK) SetPayload ¶
func (o *GetDocsSwaggerYmlOK) SetPayload(payload string)
SetPayload sets the payload to the get docs swagger yml o k response
func (*GetDocsSwaggerYmlOK) WithPayload ¶
func (o *GetDocsSwaggerYmlOK) WithPayload(payload string) *GetDocsSwaggerYmlOK
WithPayload adds the payload to the get docs swagger yml o k response
func (*GetDocsSwaggerYmlOK) WriteResponse ¶
func (o *GetDocsSwaggerYmlOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type GetDocsSwaggerYmlParams ¶
GetDocsSwaggerYmlParams contains all the bound params for the get docs swagger yml operation typically these are obtained from a http.Request
swagger:parameters GetDocsSwaggerYml
func NewGetDocsSwaggerYmlParams ¶
func NewGetDocsSwaggerYmlParams() GetDocsSwaggerYmlParams
NewGetDocsSwaggerYmlParams creates a new GetDocsSwaggerYmlParams object with the default values initialized.
func (*GetDocsSwaggerYmlParams) BindRequest ¶
func (o *GetDocsSwaggerYmlParams) BindRequest(r *http.Request, route *middleware.MatchedRoute) error
BindRequest both binds and validates a request, it assumes that complex things implement a Validatable(strfmt.Registry) error interface for simple values it will use straight method calls
type GetDocsSwaggerYmlURL ¶
type GetDocsSwaggerYmlURL struct {
// contains filtered or unexported fields
}
GetDocsSwaggerYmlURL generates an URL for the get docs swagger yml operation
func (*GetDocsSwaggerYmlURL) Build ¶
func (o *GetDocsSwaggerYmlURL) Build() (*url.URL, error)
Build a url path and query string
func (*GetDocsSwaggerYmlURL) BuildFull ¶
func (o *GetDocsSwaggerYmlURL) BuildFull(scheme, host string) (*url.URL, error)
BuildFull builds a full url with scheme, host, path and query string
func (*GetDocsSwaggerYmlURL) Must ¶
Must is a helper function to panic when the url builder returns an error
func (*GetDocsSwaggerYmlURL) SetBasePath ¶
func (o *GetDocsSwaggerYmlURL) SetBasePath(bp string)
SetBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string
func (*GetDocsSwaggerYmlURL) String ¶
func (o *GetDocsSwaggerYmlURL) String() string
String returns the string representation of the path with query string
func (*GetDocsSwaggerYmlURL) StringFull ¶
func (o *GetDocsSwaggerYmlURL) StringFull(scheme, host string) string
StringFull returns the string representation of a complete url
func (*GetDocsSwaggerYmlURL) WithBasePath ¶
func (o *GetDocsSwaggerYmlURL) WithBasePath(bp string) *GetDocsSwaggerYmlURL
WithBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string
type GetDocsURL ¶
type GetDocsURL struct {
// contains filtered or unexported fields
}
GetDocsURL generates an URL for the get docs operation
func (*GetDocsURL) Build ¶
func (o *GetDocsURL) Build() (*url.URL, error)
Build a url path and query string
func (*GetDocsURL) BuildFull ¶
func (o *GetDocsURL) BuildFull(scheme, host string) (*url.URL, error)
BuildFull builds a full url with scheme, host, path and query string
func (*GetDocsURL) SetBasePath ¶
func (o *GetDocsURL) SetBasePath(bp string)
SetBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string
func (*GetDocsURL) String ¶
func (o *GetDocsURL) String() string
String returns the string representation of the path with query string
func (*GetDocsURL) StringFull ¶
func (o *GetDocsURL) StringFull(scheme, host string) string
StringFull returns the string representation of a complete url
func (*GetDocsURL) WithBasePath ¶
func (o *GetDocsURL) WithBasePath(bp string) *GetDocsURL
WithBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string
Source Files