api

Documentation

Index

• func EchoAPI() *echo.Echo
• func V1GetFeed(ctx echo.Context) error
• type API
  • func (a *API) New() *echo.Echo
  • func (a *API) NewOnce(setup SetupFunc) *echo.Echo
• type SetupFunc

Functions

func EchoAPI

func EchoAPI() *echo.Echo

EchoAPI Deprecated interfaces. Will be removed in v2.0

func V1GetFeed

func V1GetFeed(ctx echo.Context) error

V1GetFeed godoc

@Description	Generates RSS/Atom feed
@Tags			feeds fetch
@Accept			json
@Produce		application/atom+xml
@Produce		application/feed+json
@Produce		application/rss+xml
@Param			format		path	brrss.FeedFormat	true	"Output feed format"
@Param			url			query	string				true	"Source URL"					format(string)
@Param			item		query	string				true	"Article selector"				format(string)
@Param			feed-title	query	string				false	"Feed title selector"			format(string)
@Param			feed-desc	query	string				false	"Feed description selector"		format(string)
@Param			item-time	query	string				false	"Article time selector"			format(string)
@Param			item-desc	query	string				false	"Article description selector"	format(string)
@Param			item-link	query	string				false	"Article link selector"			format(string)
@Param			item-title	query	string				false	"Article title selector"		format(string)
@Param			req-headers	query	[]string			false	"Outgoing request headers"		collectionFormat(multi)
@Router			/v1/feed/{format} [get]
@Security		ApiKeyAuth || BasicAuth

Types

type API

type API struct {
	Echo *echo.Echo
	// contains filtered or unexported fields
}

func (*API) New

func (a *API) New() *echo.Echo

func (*API) NewOnce

func (a *API) NewOnce(setup SetupFunc) *echo.Echo

type SetupFunc

type SetupFunc func(api *API)