Gotham

HTTP API for a comic book app.

API Documentation

Home resource

Request

GET / HTTP/1.1
Host: gotham
Accept: application/json

Response

HTTP/1.1 200 OK
Content-Type: application/json

{
	"series": [
		{
			"title": "Prophet",
			"links": [
				{"rel":"self", "href": "http://gotham/series/random"},
				{"rel":"seriesimage", "href": "http://gotham/pages/random/0.jpg"},
				{"rel":"promotedbook", "href": "http://gotham/books/random"}
			],
		},
		{
			"title": "Jupiter's Legacy",
			"links": [
				{"rel":"self", "href": "http://gotham/series/random"},
				{"rel":"seriesimage", "href": "http://gotham/pages/random/0.jpg"},
				{"rel":"promotedbook", "href": "http://gotham/books/random"}
			],
		}
	]
}

Series resource

Request

GET /series/{opaque} HTTP/1.1
Host: gotham
Accept: application/json

Response

HTTP/1.1 200 OK
Content-Type: application/json

{
	"title": "Saga",
	"books": [
		{
			"title": "Saga 13",
			"publishedDate": "2013-08-14T00:00:00Z", // RFC 3339 format
			"writtenBy": ["Brian K. Vaughan"],
			"artBy": ["Fiona Staples"],
			"blurb": "THE SMASH-HIT, CRITICALLY ACCLAIMED SERIES RETURNS!\nNow that you've read the first two bestselling collections of SAGA, you're all caught up and ready to jump on the ongoing train with Chapter Thirteen, beginning an all-new monthly sci-fi/fantasy adventure, as Hazel and her parents head to the planet Quietus in search of cult romance novelist D. Oswald Heist.",
			"links": [
				{"rel":"self", "href": "http://gotham/books/{opaque}"},
				{"rel":"image", "href": "http://gotham/pages/{opaque}"}
			]
		},
		{
			"title": "Saga 12",
			"publishedDate": "2013-04-10T00:00:00Z",
			"writtenBy": ["Brian K. Vaughan"],
			"artBy": ["Fiona Staples"],
			"blurb": "Prince Robot IV makes his move.",
			"links": [
				{"rel":"self", "href": "http://gotham/books/{opaque}"},
				{"rel":"image", "href": "http://gotham/pages/{opaque}"}
			]
		}
	]
}

Comic resource

Add a comic

The comic resource can be used to add comics.

Requests are formed as multipart/form-data. The first part is expected to be the metadata for the comic represented as application/json with "metadata" as the field-name. The subsequent parts should be the page images for the comic, which must have a field-name of "page". The page images must be in the order by which they are to be displayed. The images are stored under the filename specified in the filename parameter of the part. The only page image format currently supported is image/jpeg.

A comic must have at least 1 page image.

Request

POST /books HTTP/1.1
Host: gotham
Accept: application/json
Content-Type: multipart/form-data; boundary=Any-ASCII-string

--Any-ASCII-string
Content-Disposition: form-data; name="metadata"
Content-Type: application/json

{
	"seriesTitle": "Prophet",
	"title": "Prophet 31",
	"publishedDate": "2012-11-28T00:00:00Z", // RFC 3339 format
	"writtenBy": ["Brandon Graham", "Simon Roy", "Giannis Milonogiannis"],
	"artBy": ["Giannis Milonogiannis"],
	"blurb": "Old Man Prophet goes to meet with a lost matriarchal tribe of humanity to try to form an alliance."
}
--Any-ASCII-string
Content-Disposition: form-data; name="page"; filename="0.jpg"
Content-Type: image/jpeg

<Binary content goes here>
--Any-ASCII-string
Content-Disposition: form-data; name="page"; filename="1.jpg"
Content-Type: image/jpeg

<Binary content goes here>
--Any-ASCII-string
Content-Disposition: form-data; name="page"; filename="2.jpg"
Content-Type: image/jpeg

<Binary content goes here>
--Any-ASCII-string--

Response

HTTP/1.1 204 No Content

Get a comic

Request

GET /books/{random} HTTP/1.1
Host: gotham
Accept: application/json

Response

HTTP/1.1 200 OK
Content-Type: application/json

{
	"links":[
		{"rel":"item","href":"http://gotham/pages/random/0.jpg"},
		{"rel":"item","href":"http://gotham/pages/random/1.jpg"},
		{"rel":"item","href":"http://gotham/pages/random/2.jpg"},
		{"rel":"item","href":"http://gotham/pages/random/3.jpg"}
	]
}

Contributing

Directory Structure

• digitalocean/ - scripts to configure and deploy to DigitalOcean.
• env/ - common scripts for provisioning deployment environments. These may be shared between environments, e.g. DigitalOcean and Vagrant.
• etc/ - configuration scripts for the Gotham program itself.
• src/ - Source code for Gotham, including dependencies brought in by go.
• vagrant/ - vagrant specific provisioning script files.