interagent / http-api-design

HTTP API design guide extracted from work on the Heroku Platform API
https://geemus.gitbooks.io/http-api-design/content/en/
Other
13.69k stars 1.07k forks source link

Explain every paragraph #53

Open ksimka opened 10 years ago

ksimka commented 10 years ago

Looks that I'm not the only one who wants to know why it's recommended to do something in that way or another.

So it'll be super helpful to have explanation under each paragraph, cause it helps to understand things and not only blindly follow someone's tips. And we don't need right explanation (I think there's no one), only what the author thinks, why he does so.

mariussoutier commented 10 years ago

:+1:

geemus commented 10 years ago

Agreed, I'd love to add a couple more bullets (as well as a paragraph or more of explanation for each). I hope to find some time in the not too distant future, but a bit swamped presently. Feel free to continue to prod me periodically if I haven't managed it yet. Thanks!

Gregliest commented 9 years ago

Agree, has there been any progress on this?

geemus commented 9 years ago

In my head, YES! But with words I can share, not as much so far. I'm hoping to make some progress in the near term though, just stuck behind a couple other urgent tasks. Hoping it won't lie idle for nearly as long this time as it did before though.