Project 1: API Showdown
Last updated

Project 1: API Showdown

For each step below, do the work in a non-main branch, and then open a PR and have your partner share the screen to do the visual review approval and merge before you continue on to the next step.

Add APIs

Create a "Revel" website that showcases three common public APIs:

Add API guides

Spend a maximum of 1 hour on this step.

Add brief contextual docs such as getting started guide to at least one of those APIs as separate Markdown files.

Add "why we created this information architecture" page

Detour #1: Your boss can't decide between three approaches without a visual. Create a screenshot of each of the following options:

  • Use a single sidebar to show all three products. Need help?
  • Use the navbar to show all three products. Need help?
  • Use the catalog to show all three products. Need help?

Decide on which approach is better for this website, and add a page of content to your website that shows screenshots of all three and explains why the selected approach was taken.

Add API comparison page

Add contextual content that compares and contrasts the three APIs across some criteria (you decide on the criteria but timebox the content creation to 2 hours).

Ideas to consider
  • Lint the APIs to find differences in OpenAPI correctness or consistency.
  • Use the scorecard to show the differences.
  • Use the stats CLI to find summary statistics.
  • Review manually and identify differences.

Add one thing to the Museum API

Anything big or small. The goal is to edit the actual OpenAPI file. If you're not familiar with OpenAPI, editing a description is easy. More ambitious would be to add a new tag and set of operations.

Add a changelog.md to the Museum API (and add it so it shows in the sidebar when someone is viewing the Museum API). The changelog entry should explain what you added or changed and why you did it.

Add custom domain

Your CNAME record is pre-configured to point to ssl.cloud.redocly.com:

  • {company}.apishowdown.com (all lowercase)

Use that to set up the custom domain.

Your website is public (unprotected). This is a "Revel" use case.

Add review of your experience

Spend a maximum of 1 hour on this step.

Add one more page: "Experience review"

  1. What gave you a smile?
  2. What was most confusing?

Add screenshots or selfies if you can.

Summary

  1. You did the preparation before you start.
  2. Add three APIs.
  3. Add contextual docs to at least one of the APIs.
  4. Add information architecture page.
  5. Add API comparison page.
  6. Add one thing to the Museum API.
  7. Add custom domain.
  8. Add review of your experience.
Previous page
Next page