Tools and first-week setup

The tools a API Design intern uses and how to set up your workspace in week one.

These are the main tools for API Design tasks. You do not need all of them on day one; the Level 1 tasks tell you when to install each one.

  • OpenAPI / Swagger
  • Postman
  • Node.js or Python
  • GraphQL
  • gRPC

Set up your workspace

  • Create a free GitHub account if you do not have one, with a professional username, and set up your LinkedIn profile: every task is submitted with a LinkedIn post.
  • Create one repository for the internship, for example api-design-internship, with a README that says who you are and what the repo holds.
  • Keep one folder per task, named with the task number and title, so mentors find your work quickly.
  • Commit small changes every day with clear messages. Your daily work report uses these commits as proof.
  • Never commit passwords, API keys or personal data. Put secrets in a .env file and add it to .gitignore.

Your first tasks

TaskWhat to do
What an API isExplain APIs, clients and servers, and compare REST, GraphQL, gRPC and webhooks in a table.
HTTP for API designersDocument every HTTP method and the 15 most useful status codes with when to return each.
Resource namingDesign URLs for a hospital system (patients, doctors, appointments) using nouns, plurals and nesting rules.
Request and response designWrite example JSON requests and responses for each endpoint with consistent field naming.
โ† What a API Design intern doesAll 60 tasks, level by level โ†’