Documentation
¶
Overview ¶
Package api provides primitives to interact with the openapi HTTP API.
Code generated by github.com/deepmap/oapi-codegen/v2 version v2.1.0 DO NOT EDIT.
Package api provides primitives to interact with the openapi HTTP API.
Code generated by github.com/deepmap/oapi-codegen/v2 version v2.1.0 DO NOT EDIT.
Index ¶
- func GetSwagger() (swagger *openapi3.T, err error)
- func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error)
- func RegisterHandlers(router EchoRouter, si ServerInterface)
- func RegisterHandlersWithBaseURL(router EchoRouter, si ServerInterface, baseURL string)
- type AnilistManga
- type Chapter
- type CoverImage
- type EchoRouter
- type Error
- type Format
- type GetChapter200JSONResponse
- type GetChapterParams
- type GetChapterRequestObject
- type GetChapterResponseObject
- type GetFormats200JSONResponse
- type GetFormatsRequestObject
- type GetFormatsResponseObject
- type GetImage200ImagepngResponse
- type GetImageParams
- type GetImageRequestObject
- type GetImageResponseObject
- type GetManga200JSONResponse
- type GetManga404Response
- type GetMangaPage200JSONResponse
- type GetMangaPageParams
- type GetMangaPageRequestObject
- type GetMangaPageResponseObject
- type GetMangaPagedefaultJSONResponse
- type GetMangaParams
- type GetMangaRequestObject
- type GetMangaResponseObject
- type GetMangaVolumes200JSONResponse
- type GetMangaVolumesParams
- type GetMangaVolumesRequestObject
- type GetMangaVolumesResponseObject
- type GetMangaVolumesdefaultJSONResponse
- type GetMangadefaultJSONResponse
- type GetMangalInfo200JSONResponse
- type GetMangalInfoRequestObject
- type GetMangalInfoResponseObject
- type GetMangalInfodefaultJSONResponse
- type GetProvider200JSONResponse
- type GetProvider404Response
- type GetProviderParams
- type GetProviderRequestObject
- type GetProviderResponseObject
- type GetProviders200JSONResponse
- type GetProvidersRequestObject
- type GetProvidersResponseObject
- type GetProvidersdefaultJSONResponse
- type GetVolumeChapters200JSONResponse
- type GetVolumeChaptersParams
- type GetVolumeChaptersRequestObject
- type GetVolumeChaptersResponseObject
- type GetVolumeChaptersdefaultJSONResponse
- type Image
- type Manga
- type MangaPage
- type MangalInfo
- type Provider
- type SearchMangas200JSONResponse
- type SearchMangasParams
- type SearchMangasRequestObject
- type SearchMangasResponseObject
- type SearchMangasdefaultJSONResponse
- type ServerInterface
- type ServerInterfaceWrapper
- func (w *ServerInterfaceWrapper) GetChapter(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) GetFormats(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) GetImage(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) GetManga(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) GetMangaPage(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) GetMangaVolumes(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) GetMangalInfo(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) GetProvider(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) GetProviders(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) GetVolumeChapters(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) SearchMangas(ctx echo.Context) error
- type StrictHandlerFunc
- type StrictMiddlewareFunc
- type StrictServerInterface
- type Volume
- type VolumeWithChapters
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GetSwagger ¶
GetSwagger returns the Swagger specification corresponding to the generated code in this file. The external references of Swagger specification are resolved. The logic of resolving external references is tightly connected to "import-mapping" feature. Externally referenced files must be embedded in the corresponding golang packages. Urls can be supported but this task was out of the scope.
func PathToRawSpec ¶
Constructs a synthetic filesystem for resolving external references when loading openapi specifications.
func RegisterHandlers ¶
func RegisterHandlers(router EchoRouter, si ServerInterface)
RegisterHandlers adds each server route to the EchoRouter.
func RegisterHandlersWithBaseURL ¶
func RegisterHandlersWithBaseURL(router EchoRouter, si ServerInterface, baseURL string)
Registers handlers, and prepends BaseURL to the paths, so that the paths can be served under a prefix.
Types ¶
type AnilistManga ¶
type AnilistManga struct {
BannerImage *string `json:"bannerImage,omitempty"`
CoverImage CoverImage `json:"coverImage"`
Description *string `json:"description,omitempty"`
}
AnilistManga defines model for AnilistManga.
type Chapter ¶
type Chapter struct {
Number float32 `json:"number"`
Title string `json:"title"`
Url *string `json:"url,omitempty"`
}
Chapter defines model for Chapter.
type CoverImage ¶
type CoverImage struct {
Color string `json:"color"`
ExtraLarge string `json:"extraLarge"`
Large string `json:"large"`
Medium string `json:"medium"`
}
CoverImage defines model for CoverImage.
type EchoRouter ¶
type EchoRouter interface {
CONNECT(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
DELETE(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
GET(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
HEAD(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
OPTIONS(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
PATCH(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
POST(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
PUT(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
TRACE(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
}
This is a simple interface which specifies echo.Route addition functions which are present on both echo.Echo and echo.Group, since we want to allow using either of them for path registration
type GetChapter200JSONResponse ¶
type GetChapter200JSONResponse Chapter
func (GetChapter200JSONResponse) VisitGetChapterResponse ¶
func (response GetChapter200JSONResponse) VisitGetChapterResponse(w http.ResponseWriter) error
type GetChapterParams ¶
type GetChapterParams struct {
// Provider provider id to use
Provider string `form:"provider" json:"provider"`
// Query manga search query
Query string `form:"query" json:"query"`
// Manga manga id
Manga string `form:"manga" json:"manga"`
// Volume volume number
Volume float32 `form:"volume" json:"volume"`
}
GetChapterParams defines parameters for GetChapter.
type GetChapterRequestObject ¶
type GetChapterRequestObject struct {
Params GetChapterParams
}
type GetChapterResponseObject ¶
type GetChapterResponseObject interface {
VisitGetChapterResponse(w http.ResponseWriter) error
}
type GetFormats200JSONResponse ¶
type GetFormats200JSONResponse []Format
func (GetFormats200JSONResponse) VisitGetFormatsResponse ¶
func (response GetFormats200JSONResponse) VisitGetFormatsResponse(w http.ResponseWriter) error
type GetFormatsRequestObject ¶
type GetFormatsRequestObject struct {
}
type GetFormatsResponseObject ¶
type GetFormatsResponseObject interface {
VisitGetFormatsResponse(w http.ResponseWriter) error
}
type GetImage200ImagepngResponse ¶
func (GetImage200ImagepngResponse) VisitGetImageResponse ¶
func (response GetImage200ImagepngResponse) VisitGetImageResponse(w http.ResponseWriter) error
type GetImageParams ¶
type GetImageParams struct {
// Url image url to download
Url string `form:"url" json:"url"`
// Referer referer to use to get the image
Referer *string `form:"referer,omitempty" json:"referer,omitempty"`
}
GetImageParams defines parameters for GetImage.
type GetImageRequestObject ¶
type GetImageRequestObject struct {
Params GetImageParams
}
type GetImageResponseObject ¶
type GetImageResponseObject interface {
VisitGetImageResponse(w http.ResponseWriter) error
}
type GetManga200JSONResponse ¶
type GetManga200JSONResponse Manga
func (GetManga200JSONResponse) VisitGetMangaResponse ¶
func (response GetManga200JSONResponse) VisitGetMangaResponse(w http.ResponseWriter) error
type GetManga404Response ¶
type GetManga404Response struct {
}
func (GetManga404Response) VisitGetMangaResponse ¶
func (response GetManga404Response) VisitGetMangaResponse(w http.ResponseWriter) error
type GetMangaPage200JSONResponse ¶
type GetMangaPage200JSONResponse MangaPage
func (GetMangaPage200JSONResponse) VisitGetMangaPageResponse ¶
func (response GetMangaPage200JSONResponse) VisitGetMangaPageResponse(w http.ResponseWriter) error
type GetMangaPageParams ¶
type GetMangaPageParams struct {
// Provider provider id to use
Provider string `form:"provider" json:"provider"`
// Query manga search query
Query string `form:"query" json:"query"`
// Manga manga id
Manga string `form:"manga" json:"manga"`
}
GetMangaPageParams defines parameters for GetMangaPage.
type GetMangaPageRequestObject ¶
type GetMangaPageRequestObject struct {
Params GetMangaPageParams
}
type GetMangaPageResponseObject ¶
type GetMangaPageResponseObject interface {
VisitGetMangaPageResponse(w http.ResponseWriter) error
}
type GetMangaPagedefaultJSONResponse ¶
func (GetMangaPagedefaultJSONResponse) VisitGetMangaPageResponse ¶
func (response GetMangaPagedefaultJSONResponse) VisitGetMangaPageResponse(w http.ResponseWriter) error
type GetMangaParams ¶
type GetMangaParams struct {
// Provider provider id to use
Provider string `form:"provider" json:"provider"`
// Query manga search query
Query string `form:"query" json:"query"`
// Manga manga id
Manga string `form:"manga" json:"manga"`
}
GetMangaParams defines parameters for GetManga.
type GetMangaRequestObject ¶
type GetMangaRequestObject struct {
Params GetMangaParams
}
type GetMangaResponseObject ¶
type GetMangaResponseObject interface {
VisitGetMangaResponse(w http.ResponseWriter) error
}
type GetMangaVolumes200JSONResponse ¶
type GetMangaVolumes200JSONResponse []Volume
func (GetMangaVolumes200JSONResponse) VisitGetMangaVolumesResponse ¶
func (response GetMangaVolumes200JSONResponse) VisitGetMangaVolumesResponse(w http.ResponseWriter) error
type GetMangaVolumesParams ¶
type GetMangaVolumesParams struct {
// Provider provider id to use
Provider string `form:"provider" json:"provider"`
// Query manga search query
Query string `form:"query" json:"query"`
// Manga manga id
Manga string `form:"manga" json:"manga"`
}
GetMangaVolumesParams defines parameters for GetMangaVolumes.
type GetMangaVolumesRequestObject ¶
type GetMangaVolumesRequestObject struct {
Params GetMangaVolumesParams
}
type GetMangaVolumesResponseObject ¶
type GetMangaVolumesResponseObject interface {
VisitGetMangaVolumesResponse(w http.ResponseWriter) error
}
type GetMangaVolumesdefaultJSONResponse ¶
func (GetMangaVolumesdefaultJSONResponse) VisitGetMangaVolumesResponse ¶
func (response GetMangaVolumesdefaultJSONResponse) VisitGetMangaVolumesResponse(w http.ResponseWriter) error
type GetMangadefaultJSONResponse ¶
func (GetMangadefaultJSONResponse) VisitGetMangaResponse ¶
func (response GetMangadefaultJSONResponse) VisitGetMangaResponse(w http.ResponseWriter) error
type GetMangalInfo200JSONResponse ¶
type GetMangalInfo200JSONResponse MangalInfo
func (GetMangalInfo200JSONResponse) VisitGetMangalInfoResponse ¶
func (response GetMangalInfo200JSONResponse) VisitGetMangalInfoResponse(w http.ResponseWriter) error
type GetMangalInfoRequestObject ¶
type GetMangalInfoRequestObject struct {
}
type GetMangalInfoResponseObject ¶
type GetMangalInfoResponseObject interface {
VisitGetMangalInfoResponse(w http.ResponseWriter) error
}
type GetMangalInfodefaultJSONResponse ¶
func (GetMangalInfodefaultJSONResponse) VisitGetMangalInfoResponse ¶
func (response GetMangalInfodefaultJSONResponse) VisitGetMangalInfoResponse(w http.ResponseWriter) error
type GetProvider200JSONResponse ¶
type GetProvider200JSONResponse Provider
func (GetProvider200JSONResponse) VisitGetProviderResponse ¶
func (response GetProvider200JSONResponse) VisitGetProviderResponse(w http.ResponseWriter) error
type GetProvider404Response ¶
type GetProvider404Response struct {
}
func (GetProvider404Response) VisitGetProviderResponse ¶
func (response GetProvider404Response) VisitGetProviderResponse(w http.ResponseWriter) error
type GetProviderParams ¶
type GetProviderParams struct {
// Id provider id
Id string `form:"id" json:"id"`
}
GetProviderParams defines parameters for GetProvider.
type GetProviderRequestObject ¶
type GetProviderRequestObject struct {
Params GetProviderParams
}
type GetProviderResponseObject ¶
type GetProviderResponseObject interface {
VisitGetProviderResponse(w http.ResponseWriter) error
}
type GetProviders200JSONResponse ¶
type GetProviders200JSONResponse []Provider
func (GetProviders200JSONResponse) VisitGetProvidersResponse ¶
func (response GetProviders200JSONResponse) VisitGetProvidersResponse(w http.ResponseWriter) error
type GetProvidersRequestObject ¶
type GetProvidersRequestObject struct {
}
type GetProvidersResponseObject ¶
type GetProvidersResponseObject interface {
VisitGetProvidersResponse(w http.ResponseWriter) error
}
type GetProvidersdefaultJSONResponse ¶
func (GetProvidersdefaultJSONResponse) VisitGetProvidersResponse ¶
func (response GetProvidersdefaultJSONResponse) VisitGetProvidersResponse(w http.ResponseWriter) error
type GetVolumeChapters200JSONResponse ¶
type GetVolumeChapters200JSONResponse []Chapter
func (GetVolumeChapters200JSONResponse) VisitGetVolumeChaptersResponse ¶
func (response GetVolumeChapters200JSONResponse) VisitGetVolumeChaptersResponse(w http.ResponseWriter) error
type GetVolumeChaptersParams ¶
type GetVolumeChaptersParams struct {
// Provider provider id to use
Provider string `form:"provider" json:"provider"`
// Query manga search query
Query string `form:"query" json:"query"`
// Manga manga id
Manga string `form:"manga" json:"manga"`
// Volume volume number
Volume float32 `form:"volume" json:"volume"`
}
GetVolumeChaptersParams defines parameters for GetVolumeChapters.
type GetVolumeChaptersRequestObject ¶
type GetVolumeChaptersRequestObject struct {
Params GetVolumeChaptersParams
}
type GetVolumeChaptersResponseObject ¶
type GetVolumeChaptersResponseObject interface {
VisitGetVolumeChaptersResponse(w http.ResponseWriter) error
}
type GetVolumeChaptersdefaultJSONResponse ¶
func (GetVolumeChaptersdefaultJSONResponse) VisitGetVolumeChaptersResponse ¶
func (response GetVolumeChaptersdefaultJSONResponse) VisitGetVolumeChaptersResponse(w http.ResponseWriter) error
type Manga ¶
type Manga struct {
Banner *string `json:"banner,omitempty"`
Cover *string `json:"cover,omitempty"`
Id string `json:"id"`
Title string `json:"title"`
Url *string `json:"url,omitempty"`
}
Manga defines model for Manga.
type MangaPage ¶
type MangaPage struct {
AnilistManga *AnilistManga `json:"anilistManga,omitempty"`
Manga Manga `json:"manga"`
Volumes []VolumeWithChapters `json:"volumes"`
}
MangaPage defines model for MangaPage.
type MangalInfo ¶
type MangalInfo struct {
Version string `json:"version"`
}
MangalInfo defines model for MangalInfo.
type Provider ¶
type Provider struct {
Description *string `json:"description,omitempty"`
Id string `json:"id"`
Name string `json:"name"`
Version string `json:"version"`
}
Provider defines model for Provider.
type SearchMangas200JSONResponse ¶
type SearchMangas200JSONResponse []Manga
func (SearchMangas200JSONResponse) VisitSearchMangasResponse ¶
func (response SearchMangas200JSONResponse) VisitSearchMangasResponse(w http.ResponseWriter) error
type SearchMangasParams ¶
type SearchMangasParams struct {
// Provider provider id to use
Provider string `form:"provider" json:"provider"`
// Query manga search query
Query string `form:"query" json:"query"`
}
SearchMangasParams defines parameters for SearchMangas.
type SearchMangasRequestObject ¶
type SearchMangasRequestObject struct {
Params SearchMangasParams
}
type SearchMangasResponseObject ¶
type SearchMangasResponseObject interface {
VisitSearchMangasResponse(w http.ResponseWriter) error
}
type SearchMangasdefaultJSONResponse ¶
func (SearchMangasdefaultJSONResponse) VisitSearchMangasResponse ¶
func (response SearchMangasdefaultJSONResponse) VisitSearchMangasResponse(w http.ResponseWriter) error
type ServerInterface ¶
type ServerInterface interface {
// (GET /chapter)
GetChapter(ctx echo.Context, params GetChapterParams) error
// (GET /formats)
GetFormats(ctx echo.Context) error
// (GET /image)
GetImage(ctx echo.Context, params GetImageParams) error
// (GET /manga)
GetManga(ctx echo.Context, params GetMangaParams) error
// (GET /mangaPage)
GetMangaPage(ctx echo.Context, params GetMangaPageParams) error
// (GET /mangaVolumes)
GetMangaVolumes(ctx echo.Context, params GetMangaVolumesParams) error
// (GET /mangalInfo)
GetMangalInfo(ctx echo.Context) error
// (GET /provider)
GetProvider(ctx echo.Context, params GetProviderParams) error
// (GET /providers)
GetProviders(ctx echo.Context) error
// (GET /searchMangas)
SearchMangas(ctx echo.Context, params SearchMangasParams) error
// (GET /volumeChapters)
GetVolumeChapters(ctx echo.Context, params GetVolumeChaptersParams) error
}
ServerInterface represents all server handlers.
func NewStrictHandler ¶
func NewStrictHandler(ssi StrictServerInterface, middlewares []StrictMiddlewareFunc) ServerInterface
type ServerInterfaceWrapper ¶
type ServerInterfaceWrapper struct {
Handler ServerInterface
}
ServerInterfaceWrapper converts echo contexts to parameters.
func (*ServerInterfaceWrapper) GetChapter ¶
func (w *ServerInterfaceWrapper) GetChapter(ctx echo.Context) error
GetChapter converts echo context to params.
func (*ServerInterfaceWrapper) GetFormats ¶
func (w *ServerInterfaceWrapper) GetFormats(ctx echo.Context) error
GetFormats converts echo context to params.
func (*ServerInterfaceWrapper) GetImage ¶
func (w *ServerInterfaceWrapper) GetImage(ctx echo.Context) error
GetImage converts echo context to params.
func (*ServerInterfaceWrapper) GetManga ¶
func (w *ServerInterfaceWrapper) GetManga(ctx echo.Context) error
GetManga converts echo context to params.
func (*ServerInterfaceWrapper) GetMangaPage ¶
func (w *ServerInterfaceWrapper) GetMangaPage(ctx echo.Context) error
GetMangaPage converts echo context to params.
func (*ServerInterfaceWrapper) GetMangaVolumes ¶
func (w *ServerInterfaceWrapper) GetMangaVolumes(ctx echo.Context) error
GetMangaVolumes converts echo context to params.
func (*ServerInterfaceWrapper) GetMangalInfo ¶
func (w *ServerInterfaceWrapper) GetMangalInfo(ctx echo.Context) error
GetMangalInfo converts echo context to params.
func (*ServerInterfaceWrapper) GetProvider ¶
func (w *ServerInterfaceWrapper) GetProvider(ctx echo.Context) error
GetProvider converts echo context to params.
func (*ServerInterfaceWrapper) GetProviders ¶
func (w *ServerInterfaceWrapper) GetProviders(ctx echo.Context) error
GetProviders converts echo context to params.
func (*ServerInterfaceWrapper) GetVolumeChapters ¶
func (w *ServerInterfaceWrapper) GetVolumeChapters(ctx echo.Context) error
GetVolumeChapters converts echo context to params.
func (*ServerInterfaceWrapper) SearchMangas ¶
func (w *ServerInterfaceWrapper) SearchMangas(ctx echo.Context) error
SearchMangas converts echo context to params.
type StrictHandlerFunc ¶
type StrictHandlerFunc = strictecho.StrictEchoHandlerFunc
type StrictMiddlewareFunc ¶
type StrictMiddlewareFunc = strictecho.StrictEchoMiddlewareFunc
type StrictServerInterface ¶
type StrictServerInterface interface {
// (GET /chapter)
GetChapter(ctx context.Context, request GetChapterRequestObject) (GetChapterResponseObject, error)
// (GET /formats)
GetFormats(ctx context.Context, request GetFormatsRequestObject) (GetFormatsResponseObject, error)
// (GET /image)
GetImage(ctx context.Context, request GetImageRequestObject) (GetImageResponseObject, error)
// (GET /manga)
GetManga(ctx context.Context, request GetMangaRequestObject) (GetMangaResponseObject, error)
// (GET /mangaPage)
GetMangaPage(ctx context.Context, request GetMangaPageRequestObject) (GetMangaPageResponseObject, error)
// (GET /mangaVolumes)
GetMangaVolumes(ctx context.Context, request GetMangaVolumesRequestObject) (GetMangaVolumesResponseObject, error)
// (GET /mangalInfo)
GetMangalInfo(ctx context.Context, request GetMangalInfoRequestObject) (GetMangalInfoResponseObject, error)
// (GET /provider)
GetProvider(ctx context.Context, request GetProviderRequestObject) (GetProviderResponseObject, error)
// (GET /providers)
GetProviders(ctx context.Context, request GetProvidersRequestObject) (GetProvidersResponseObject, error)
// (GET /searchMangas)
SearchMangas(ctx context.Context, request SearchMangasRequestObject) (SearchMangasResponseObject, error)
// (GET /volumeChapters)
GetVolumeChapters(ctx context.Context, request GetVolumeChaptersRequestObject) (GetVolumeChaptersResponseObject, error)
}
StrictServerInterface represents all server handlers.
type Volume ¶
type Volume struct {
Number float32 `json:"number"`
}
Volume defines model for Volume.
type VolumeWithChapters ¶
type VolumeWithChapters struct {
Chapters []Chapter `json:"chapters"`
Volume Volume `json:"volume"`
}
VolumeWithChapters defines model for VolumeWithChapters.