Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/writeas/go-writeas

Go client for the Write.as API
https://github.com/writeas/go-writeas

api-client go writeas

Last synced: 29 days ago
JSON representation

Go client for the Write.as API

Awesome Lists containing this project

README

        

# go-writeas

[![godoc](https://godoc.org/github.com/writeas/go-writeas?status.svg)](https://pkg.go.dev/github.com/writeas/go-writeas/v2)

Official Write.as Go client library.

## Installation

```bash
go get github.com/writeas/go-writeas/v2
```

## Documentation

See all functionality and usages in the [API documentation](https://developers.write.as/docs/api/).

### Example usage

```go
import "github.com/writeas/go-writeas/v2"

func main() {
// Create the client
c := writeas.NewClient()

// Publish a post
p, err := c.CreatePost(&writeas.PostParams{
Title: "Title!",
Content: "This is a post.",
Font: "sans",
})
if err != nil {
// Perhaps show err.Error()
}

// Save token for later, since it won't ever be returned again
token := p.Token

// Update a published post
p, err = c.UpdatePost(p.ID, token, &writeas.PostParams{
Content: "Now it's been updated!",
})
if err != nil {
// handle
}

// Get a published post
p, err = c.GetPost(p.ID)
if err != nil {
// handle
}

// Delete a post
err = c.DeletePost(p.ID, token)
}
```

## Contributing

The library covers our usage, but might not be comprehensive of the API. So we always welcome contributions and improvements from the community. Before sending pull requests, make sure you've done the following:

* Run `goimports` on all updated .go files.
* Document all exported structs and funcs.

## License

MIT