1
0
mirror of https://github.com/writeas/go-writeas.git synced 2025-07-27 15:18:28 +00:00
Go client for the Write.as API https://developers.write.as
Go to file
2019-02-09 07:11:45 -05:00
.github Add GitHub issue template 2017-11-19 14:45:03 -05:00
.gitignore Initial commit 2015-09-30 15:04:38 -04:00
auth_test.go Add authentication test 2018-09-21 01:31:57 +02:00
auth.go Rearrange status checks in LogIn 2018-09-22 22:59:12 +02:00
collection_test.go Support retrieving auth'd user's collections 2018-09-20 13:02:41 +02:00
collection.go Add Description to CollectionParams 2019-02-09 07:10:47 -05:00
LICENSE Add README and LICENSE 2016-09-04 21:20:28 -04:00
post_test.go Reflect breaking v2 changes in examples and tests 2018-09-24 11:40:22 -04:00
post.go Add Slug, Created, and Updated to PostParams 2019-02-09 07:11:45 -05:00
README.md Add v2 warning in README 2018-09-24 11:41:04 -04:00
user.go Add UserSubscription struct 2018-02-15 15:14:37 -05:00
writeas.go Add NewClientWith constructor 2018-12-16 13:44:29 -08:00

go-writeas

godoc

Official Write.as Go client library.

Installation

Warning: the v2 branch is under heavy development and its API will change without notice.

For a stable API, use go.code.as/writeas.v1 and upgrade to v2 once everything is merged into master.

go get go.code.as/writeas.v2

Documentation

See all functionality and usages in the API documentation.

Example usage

import "go.code.as/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 go fmt on all updated .go files.
  • Document all exported structs and funcs.

License

MIT