Documentation
¶
Overview ¶
Package api implements API endpoints for Miniflux application.
Index ¶
- type Controller
- func (c *Controller) CreateCategory(w http.ResponseWriter, r *http.Request)
- func (c *Controller) CreateFeed(w http.ResponseWriter, r *http.Request)
- func (c *Controller) CreateUser(w http.ResponseWriter, r *http.Request)
- func (c *Controller) CurrentUser(w http.ResponseWriter, r *http.Request)
- func (c *Controller) Export(w http.ResponseWriter, r *http.Request)
- func (c *Controller) FeedIcon(w http.ResponseWriter, r *http.Request)
- func (c *Controller) GetCategories(w http.ResponseWriter, r *http.Request)
- func (c *Controller) GetEntries(w http.ResponseWriter, r *http.Request)
- func (c *Controller) GetEntry(w http.ResponseWriter, r *http.Request)
- func (c *Controller) GetFeed(w http.ResponseWriter, r *http.Request)
- func (c *Controller) GetFeedEntries(w http.ResponseWriter, r *http.Request)
- func (c *Controller) GetFeedEntry(w http.ResponseWriter, r *http.Request)
- func (c *Controller) GetFeeds(w http.ResponseWriter, r *http.Request)
- func (c *Controller) GetSubscriptions(w http.ResponseWriter, r *http.Request)
- func (c *Controller) Import(w http.ResponseWriter, r *http.Request)
- func (c *Controller) RefreshFeed(w http.ResponseWriter, r *http.Request)
- func (c *Controller) RemoveCategory(w http.ResponseWriter, r *http.Request)
- func (c *Controller) RemoveFeed(w http.ResponseWriter, r *http.Request)
- func (c *Controller) RemoveUser(w http.ResponseWriter, r *http.Request)
- func (c *Controller) SetEntryStatus(w http.ResponseWriter, r *http.Request)
- func (c *Controller) ToggleBookmark(w http.ResponseWriter, r *http.Request)
- func (c *Controller) UpdateCategory(w http.ResponseWriter, r *http.Request)
- func (c *Controller) UpdateFeed(w http.ResponseWriter, r *http.Request)
- func (c *Controller) UpdateUser(w http.ResponseWriter, r *http.Request)
- func (c *Controller) UserByID(w http.ResponseWriter, r *http.Request)
- func (c *Controller) UserByUsername(w http.ResponseWriter, r *http.Request)
- func (c *Controller) Users(w http.ResponseWriter, r *http.Request)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Controller ¶
type Controller struct {
// contains filtered or unexported fields
}
Controller holds all handlers for the API.
func NewController ¶
func NewController(store *storage.Storage, feedHandler *feed.Handler) *Controller
NewController creates a new controller.
func (*Controller) CreateCategory ¶
func (c *Controller) CreateCategory(w http.ResponseWriter, r *http.Request)
CreateCategory is the API handler to create a new category.
func (*Controller) CreateFeed ¶
func (c *Controller) CreateFeed(w http.ResponseWriter, r *http.Request)
CreateFeed is the API handler to create a new feed.
func (*Controller) CreateUser ¶
func (c *Controller) CreateUser(w http.ResponseWriter, r *http.Request)
CreateUser is the API handler to create a new user.
func (*Controller) CurrentUser ¶
func (c *Controller) CurrentUser(w http.ResponseWriter, r *http.Request)
CurrentUser is the API handler to retrieve the authenticated user.
func (*Controller) Export ¶
func (c *Controller) Export(w http.ResponseWriter, r *http.Request)
Export is the API handler that export feeds to OPML.
func (*Controller) FeedIcon ¶
func (c *Controller) FeedIcon(w http.ResponseWriter, r *http.Request)
FeedIcon returns a feed icon.
func (*Controller) GetCategories ¶
func (c *Controller) GetCategories(w http.ResponseWriter, r *http.Request)
GetCategories is the API handler to get a list of categories for a given user.
func (*Controller) GetEntries ¶
func (c *Controller) GetEntries(w http.ResponseWriter, r *http.Request)
GetEntries is the API handler to fetch entries.
func (*Controller) GetEntry ¶
func (c *Controller) GetEntry(w http.ResponseWriter, r *http.Request)
GetEntry is the API handler to get a single entry.
func (*Controller) GetFeed ¶
func (c *Controller) GetFeed(w http.ResponseWriter, r *http.Request)
GetFeed is the API handler to get a feed.
func (*Controller) GetFeedEntries ¶
func (c *Controller) GetFeedEntries(w http.ResponseWriter, r *http.Request)
GetFeedEntries is the API handler to get all feed entries.
func (*Controller) GetFeedEntry ¶
func (c *Controller) GetFeedEntry(w http.ResponseWriter, r *http.Request)
GetFeedEntry is the API handler to get a single feed entry.
func (*Controller) GetFeeds ¶
func (c *Controller) GetFeeds(w http.ResponseWriter, r *http.Request)
GetFeeds is the API handler that get all feeds that belongs to the given user.
func (*Controller) GetSubscriptions ¶
func (c *Controller) GetSubscriptions(w http.ResponseWriter, r *http.Request)
GetSubscriptions is the API handler to find subscriptions.
func (*Controller) Import ¶
func (c *Controller) Import(w http.ResponseWriter, r *http.Request)
Import is the API handler that import an OPML file.
func (*Controller) RefreshFeed ¶
func (c *Controller) RefreshFeed(w http.ResponseWriter, r *http.Request)
RefreshFeed is the API handler to refresh a feed.
func (*Controller) RemoveCategory ¶
func (c *Controller) RemoveCategory(w http.ResponseWriter, r *http.Request)
RemoveCategory is the API handler to remove a category.
func (*Controller) RemoveFeed ¶
func (c *Controller) RemoveFeed(w http.ResponseWriter, r *http.Request)
RemoveFeed is the API handler to remove a feed.
func (*Controller) RemoveUser ¶
func (c *Controller) RemoveUser(w http.ResponseWriter, r *http.Request)
RemoveUser is the API handler to remove an existing user.
func (*Controller) SetEntryStatus ¶
func (c *Controller) SetEntryStatus(w http.ResponseWriter, r *http.Request)
SetEntryStatus is the API handler to change the status of entries.
func (*Controller) ToggleBookmark ¶
func (c *Controller) ToggleBookmark(w http.ResponseWriter, r *http.Request)
ToggleBookmark is the API handler to toggle bookmark status.
func (*Controller) UpdateCategory ¶
func (c *Controller) UpdateCategory(w http.ResponseWriter, r *http.Request)
UpdateCategory is the API handler to update a category.
func (*Controller) UpdateFeed ¶
func (c *Controller) UpdateFeed(w http.ResponseWriter, r *http.Request)
UpdateFeed is the API handler that is used to update a feed.
func (*Controller) UpdateUser ¶
func (c *Controller) UpdateUser(w http.ResponseWriter, r *http.Request)
UpdateUser is the API handler to update the given user.
func (*Controller) UserByID ¶
func (c *Controller) UserByID(w http.ResponseWriter, r *http.Request)
UserByID is the API handler to fetch the given user by the ID.
func (*Controller) UserByUsername ¶
func (c *Controller) UserByUsername(w http.ResponseWriter, r *http.Request)
UserByUsername is the API handler to fetch the given user by the username.
func (*Controller) Users ¶
func (c *Controller) Users(w http.ResponseWriter, r *http.Request)
Users is the API handler to get the list of users.
Source Files