Lab: API design feedback

Discuss each other's datasets and API designs.

What to do

• Sit with your team and one other team.
• Give each other a brief intro to what your datasets contain, and how you imagine that turning into an interesting web application (i.e., what users would be able to do).
• Take 5 minutes to read each other's API designs. Links are in #general on Slack.

• For each team, have a 5-10-minute discussion around these questions:

  • Is the first component of each endpoint a noun? If not, why not?
  • Do the return values reflect the plural vs. singular nature of the name of each endpoint?
  • Are mandatory arguments for each endpoint included as URL components (i.e., items between the slashes and before the ?)? If not, why not?
  • Are GET parameters used as optional, combine-able "filter the results" arguments for the endpoints?
  • Could any of the endpoints be simplified?
  • Are there any endpoints missing that you think should be added?
• Spend a couple minutes at the end of your discussion to write down any interesting observations, lessons, or questions you came up with. Be prepared to share once we get back together.