AI

ACE AI SW Startup Training

API Design & Swagger Specification

Day 4 API Design & Swagger Specification Videos + AI chatbot learning

API Design & Swagger Specs with an AI Learning Helper (with Codex AI)

Day 4 learning content: define real service features as APIs based on screen design, user flows, sequence diagrams and data structures, and document them as Swagger/OpenAPI specs. In this lab you use Codex Client Workspace for advanced practical work, including generating API contracts automatically, auditing plan-API consistency and error handling, analyzing API change impact and finding test scenarios.

For: students who finished database design (ERD)
Bring: laptop, Swagger Editor or an OpenAPI editing tool
Format: 2h theory and API contract creation / 3h API consistency audit and impact analysis / 1h API review and test scenarios
πŸ“– Go to Session 4 guide

πŸš€ Day 4 Lab MVP Tasks Roadmap

Go to full Task board β†’
TASK 1
AI Agent Task 1

Task 1. API Contract Generation Lab

Automatically derive a RESTful Request/Response API contract from screen and DB specs.

Enter lab
TASK 2
AI Agent Task 2

Task 2. API Mismatch Detection Lab

Review consistency between the plan, screen spec and API spec, and produce a mismatch report.

Enter lab
TASK 3
AI Agent Task 3

Task 3. API Change Impact Analysis Lab

Work backward to find the chain impact on screen UI and DB modeling when API contract fields change.

Enter lab
SKILL 1
Skill Task 1

Endpoint Design Based on Domain Boundaries

Design Endpoints and URIs for 4 Domains: Video, Playback, Campaign and Ad Serving.

Enter lab
SKILL 2
Skill Task 2

Write Req/Res/Error Contracts

Define input/output Schemas, Status Codes and Error Contracts, and complete an OpenAPI 3.0 spec.

Enter lab
SKILL 3
Skill Task 3

API Contract Consistency Review

Review whether the API matches the Sequences/ERD, and extract Breaking Changes and negative test cases.

Enter lab
MISSION 1
Mission 1

[Assignment] API Review and Improvement

Review quality against REST API standards, HTTP Status and the RFC standard error schema.

Enter assignment room
MISSION 2
Mission 2

[Assignment] Generate API Test Scenarios

Derive test cases for normal operation and boundary exceptions like missing parameters and wrong date formats.

Enter assignment room
MISSION 3
Mission 3

[Assignment] Fintech Open Banking API Spec

Define OpenAPI 3.0 YAML specs and OAuth2 error formats for open banking account lookup and transfer APIs.

Enter assignment room
MISSION 4
Mission 4

[Assignment] Delivery Order-Rider API Audit

Audit Sequence-ERD consistency and Breaking Changes in delivery order and rider matching APIs.

Enter assignment room

Day 4 Lecture Videos

Recommended YouTube lectures
A list of recommended YouTube lectures on the key Day 4 topics (API design, Request/Response, Endpoints, Swagger, OpenAPI). (All are free lecture videos that allow embedding and playback.)
πŸ“š All 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 Summary Notes

Day 4 Summary

Today's key goals

On Day 4 you define real service features as APIs based on screen design, user flows and data structures, and document them as Swagger/OpenAPI specs.

  • Derive API endpoints: define REST API resources and URIs from screen requirements
  • Design Request/Response formats: define JSON request/response payload schemas
  • Define HTTP methods and status codes: design GET, POST, PUT, DELETE rules and error handling formats
  • Write Swagger/OpenAPI specs: learn to write specs in YAML/JSON
  • Plan for dev Handoff: detail exception response codes and error messages
Learning tip: ask the AI chatbot on the right questions like "What are the basic rules of RESTful API design?" or "How do I specify a Request Body and Path Parameter in Swagger?"