tlhunter / consumer-centric-api-design Goto Github PK

As pointed out by this Reddit user:

http://www.reddit.com/r/programming/comments/2d8w1o/creative_commons_book_on_api_design/cjnqddb

Much of my early usage of REST is incorrect. Also, the latter chapters I refer "hypermedia APIs" when referring to REST would make more sense.

Is there anyway that this book can be exported as a .mobi or .epub?

I'm keen on reading this on my Kindle, and native support for .mobi files would be better than .pdf.

Thank you.

It might be beneficial to convert the content of the book to Markdown, then implement some sort of Markdown to LaTeX converter, allowing people to write content in a familiar language.

The only problem is the book loses it's awesome formatting and inter-content hyperlinking.

In the mobile world it's very important to cut down on round trips. A chapter dedicated to mobile could be very useful.

OPTIONS is introduced as "nobody is going to miss [it]" and followed up with "If you plan on allowing JavaScript Consumers running within web browsers, and making requests from different domains, the OPTIONS method will need to be supported."

I think this section needs revision, as it's easy to read the former and assume the latter doesn't apply.

The relationship between zoos and employees is missing from the tables in Figure 2.1. The line (and the descriptive text) says that a zoo has 0 or more employees and an employee has 0 or more zoos but there is no foreign key in either zoo or employee table.

Seems like you need +employee_id in the zoo table or +zoo_id in the employee table (or both?).

Actually, I just realized you are using this notation to represent a join table. Sorry - this can be ignored. Thanks for the good read.

http://www.reddit.com/r/programming/comments/2d8w1o/creative_commons_book_on_api_design/cjn7aeh

The title is ambiguous and sounds like generalized API design, while this book is specifically about HTTP API design.

plz.

kthxbai.

On Windows, I can run build.sh to compile the book when I use Git Bash. There is also a minor typo too. I suggest you make the following changes:

Windows

1. Install the MiKTeX project.
2. Install Git Bash if you don't already have it.
3. Clone this repository.
4. Run ./build.sh from the root of this repository. MiKTeX will ask to install dependencies. Install them.

After reading a few lines in the book, I'm excited to read this. Looks like great info!