Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SW Essential Reading List for Designing a REST API #10

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

stuartweir
Copy link

I've curated a list of essential links to read on learning about REST APIs. It ranges from getting started with what REST APIs are, to links readers can go to to find even more information on more advanced topics such as OAuth, JWTs, Media Types, Testing, etc.

I've read through it and haven't found any spelling mistakes, and tried to remain consistent in my point of view when writing. Feel free to add/remove comments, etc as you see necessary!

-Stu


**[Objects at REST, Part 1: What Is It?](https://medium.com/@Stuart_Weir/objects-at-rest-part-1-what-is-it-3e26f0978616#.rr8x0ahz0)**

This was written recently by me, describing (in one post) many of the fundamental principles, terminology, and ideas behind RESTful APIs. While it's not too granular, I goes into some detail about what REST APIs really are to build your understanding of the technology quickly.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo:

I goes

vs

I go

or

it goes

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably worth pointing out that this is for total beginners, considering that your pull quote is defining what an API is and most of our readers already know that.

@jerodsanto
Copy link
Member

@stuartweir good post! I left you some line notes. Two pieces of overall advice:

  1. You should italicize (or "double quote") the article title names when you reference them in your own prose. That makes it more obvious that you're referencing it by name.
  2. I'd love for you to add some kind of summarizing statement at the end to wrap it all up.

Also, once we get this published we'll want an intro blurb for you (along with a picture). Check out Dennis' for an example and please provide something for me to use.

https://changelog.com/elm-functional-front-end-development-and-why-you-should-care/

🍻

@stuartweir
Copy link
Author

for my photo, the Twitter one is good :) https://twitter.com/Stuart_Weir

@jerodsanto
Copy link
Member

@stuartweir oh poop, did this slip through the cracks on me?! So sorry! 😦

I'm keen on getting this published. Think it needs any love now that it's 6+ months old?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants