Skip to content

[Issue 2561] Create Swagger UI Topic Outline#2565

Draft
daaimah123 wants to merge 3 commits intomainfrom
swaggerui
Draft

[Issue 2561] Create Swagger UI Topic Outline#2565
daaimah123 wants to merge 3 commits intomainfrom
swaggerui

Conversation

@daaimah123
Copy link
Collaborator

📝 Description

This PR adds a comprehensive topic outline for teaching Swagger UI and OpenAPI to career-changing populations transitioning into full stack engineering roles. The outline addresses the gap in curriculum content about Open API documentation and the interactive API exploration tool of Swagger UI.

🔂 Changes Made

  • New swagger-ui-openapi-guide.md - A complete topic outline covering Swagger UI and OpenAPI fundamentals
  • 5 guided activities with step-by-step setup instructions, live project references, and interactive code examples
  • All content is self-contained with no external dependencies, enabling asynchronous learning without live support

⚙️ Related Issue

Issue Number: #2561

🍏 Type of Change

New Topic Outline

🎁 Acceptance Criteria

  • Topic outline includes all required headers (Prerequisites, TOC, Objectives, Motivation, Specific Things to Learn, Lesson Activities, Common Mistakes)
  • Prerequisites reference existing Techtonica curriculum topics with proper links to the curriculum repo
  • All activities include time estimates and are designed for asynchronous, self-paced learning
  • Content includes interactive examples with live project references (Petstore, Stripe, GitHub APIs)
  • No external dependencies or references that require live support
  • Table of contents includes working hyperlinks to all major sections and activities
  • Implementation details and guided activity steps are comprehensive and actionable

🧪 How to test or what to evaluate

  1. Verify all required sections are present and well-structured
  2. Click through all table of contents hyperlinks to ensure they navigate correctly
  3. Read through the activities sequentially to ensure logical progression from beginner to intermediate concepts
  4. Copy and run the provided code snippets to verify they work as intended
  5. Confirm a learner could complete all activities independently without instructor support
  6. Test all live project references (Petstore API, Stripe API docs, GitHub API) to ensure they're accessible

🚀 Repo Notes (if applicable)

  • Table of Contents Update: YES - The main curriculum README will need to be updated to include a link to this new Swagger UI / OpenAPI topic outline in the appropriate section (likely under "APIs" or "Backend Development")
  • Impacted Repo Areas:
    • May complement existing API-related topics (REST APIs, HTTP requests)
    • Could be referenced in the backend development learning path
  • Full Time Program Curriculum Considerations:
    • Day Docs: add this as a standalone lesson day or incorporating into an existing API/backend development week
    • Integration Points: This topic naturally connects with Express.js, API design patterns, and backend testing modules
    • Prerequisites Check: Ensure participants have completed JavaScript fundamentals, command line basics, and REST API concepts before starting this module

@daaimah123 daaimah123 self-assigned this Dec 16, 2025
@daaimah123 daaimah123 marked this pull request as draft December 16, 2025 16:24
@daaimah123 daaimah123 linked an issue Jan 13, 2026 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Create Topic Outline on Swagger UI

1 participant