AI

ACE AI Startup Bootcamp

API Design & Swagger Specification

πŸ“– View Session 4 practice lesson plan ← Return to Curriculum page
Day 4 API Design & Swagger Specification Video + AI chatbot learning

API design & Swagger specification writing and AI learning helper (Codex AI linkage)

This is the 4th day's learning content that defines actual service functions in API form based on screen design, user flow, sequence diagram, and data structure, and documents them in Swagger/OpenAPI format specifications. In this exercise, Codex Client Workspace is used to perform advanced practical processes including automatic creation of API contracts, planning-API consistency auditing and error handling checks, analysis of the impact of API changes, and autonomous discovery of test scenarios.

Target audience: Students who have completed database design (ERD)
What you'll need: A laptop, Swagger Editor, or OpenAPI editing tool.
Composition: 2 hours theory and API contract creation / 3 hours API consistency auditing and impact analysis / 1 hour API review and test scenario writing
πŸ“– Go to Session 4 teaching plan

πŸš€ Day 4 Practice MVP Tasks Roadmap

Go to the entire Task board β†’
TASK 1
API Design

Task 1. API contract creation practice

Analyze requirements and screen design to create a standard RESTful API contract (api-contract.md).

Task 1 Entry to the lab
TASK 2
Spec Consistency

Task 2. API mismatch detection practice

We review the consistency between the plan, screen definition, and API specification documents and produce a report on inconsistencies.

Task 2 Entry to the lab
TASK 3
Impact Analysis

Task 3. API change impact analysis practice

Inversely infers the scope of dependent chain impacts of screen UI and DB modeling when changing API contract fields.

Task 3 Entry to the lab
MISSION 1
API Review

Mission 1. API review and improvement practice

We autonomously review the quality of compliance with REST API standards, HTTP Status, and RFC standard error schema.

Mission 1 Lab Entry
MISSION 2
API Test

Mission 2. API test scenario creation practice

Generate test cases for normal operation and boundary value exceptions such as missing parameters and date format errors.

Mission 2 Lab Entry

Day 4 lecture video

YouTube Recommended Lectures
This is a list of recommended YouTube lectures corresponding to the core topics of the Day 4 curriculum (API design, Request/Response, Endpoint, Swagger, and OpenAPI). (Constructed of free lecture videos that allow external sharing and playback.)
πŸ“š Full list of lectures (5)
  • β–Ά
    1. APIs for Beginners - Twilio
    4:13:00
  • β–Ά
    2. Full HTTP Networking & REST API Course
    4:10:00
  • β–Ά
    3. System Design Concepts and API Design
    5:15:30
  • β–Ά
    4. REST API Design best practices
    2:30:15
  • β–Ά
    5. Postman Tutorial for Beginners
    11:45

Key takeaway notes

Day 4 Summary

Today's Key Goals

On Day 4, actual service functions are defined in API form based on screen design, user flow, and data structure, and documented in Swagger/OpenAPI format specifications.

  • Derive the API endpoint: Define REST API resources and URIs based on screen requirements
  • Request/Response specification design: Define request/response payload schema in JSON structure
  • HTTP method and status code definitions: Design of GET, POST, PUT, DELETE rules and error handling specifications
  • Write a Swagger/OpenAPI specification: Learn techniques for writing specifications using YAML/JSON format
  • Consider development handoff: Exception response code and error message details
Study tip: Ask the AI chatbot on the right, β€œWhat are the basic rules of RESTful API design?” or β€œHow do I specify Request Body and Path Parameters in Swagger?” Ask the same question.