Skip to content

Haikyou/haikyou-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Haikyou API (Beta)

Haikyou JSON REST API.

Making a request

All URLs in the Haikyou API starts with http://haikyou.herokuapp.com/.

curl -i -X GET http://haikyou.herokuapp.com/something

JSON

Haikyou only support JSON for serialization of data.

Handling errors

If Haikyou is having trouble, you might see a 5xx error. 500 means that Haikyou is down, 503 Service Unavailable, or 504 Gateway Timeout.

400 means the request is bad. 422 means "Not an haiku"

API

Get all my posts

  • GET /conversation will return this.
[
	{
	  "from": "Bebop",
	  "to": "Rocksteady",
	  "visibility": "public"
	  "message": "This is not an haiku poem",
	  "date": "2014-01-22T10:56:50+01:00",
	},
	{
	  "from": "Rocksteady",
	  "to": "Bebop",
	  "visibility": "private"
	  "message": "This is yet not an haiku poem",
	  "date": "2014-01-22T10:56:51+01:00",
	},	
]

Send a message

  • PUT /conversation will send a message
{
  "from": "Bebop",
  "to": "Rocksteady",
  "visibility": "public"
  "message": "This is not an haiku poem",
}

Star a message

  • POST /conversation/id will star a message
{
  "id": "1"
  "starred": true
}

Change visibility of a message

  • POST /conversation/id will change visibility of a message
{
  "visibility": "public"
}

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors