miniflux/client/README.md

57 lines
1,013 B
Markdown
Raw Permalink Normal View History

2018-08-25 07:23:03 +02:00
Miniflux API Client
===================
[![PkgGoDev](https://pkg.go.dev/badge/miniflux.app/v2/client)](https://pkg.go.dev/miniflux.app/v2/client)
2018-08-25 07:23:03 +02:00
Client library for Miniflux REST API.
Installation
------------
```bash
go get -u miniflux.app/v2/client
2018-08-25 07:23:03 +02:00
```
Example
-------
```go
package main
import (
"fmt"
"os"
2018-08-25 07:23:03 +02:00
miniflux "miniflux.app/v2/client"
2018-08-25 07:23:03 +02:00
)
func main() {
2020-03-02 02:38:29 +01:00
// Authentication with username/password:
2018-08-25 07:23:03 +02:00
client := miniflux.New("https://api.example.org", "admin", "secret")
2020-03-02 02:38:29 +01:00
// Authentication with an API Key:
client := miniflux.New("https://api.example.org", "my-secret-token")
2018-08-25 07:23:03 +02:00
// Fetch all feeds.
feeds, err := client.Feeds()
if err != nil {
fmt.Println(err)
return
}
fmt.Println(feeds)
// Backup your feeds to an OPML file.
opml, err := client.Export()
if err != nil {
fmt.Println(err)
return
}
err = os.WriteFile("opml.xml", opml, 0644)
2018-08-25 07:23:03 +02:00
if err != nil {
fmt.Println(err)
return
}
}
```