hectoday
DocsCoursesChangelog GitHub
DocsCoursesChangelog GitHub

Access Required

Enter your access code to view courses.

Invalid code

← All courses

API documentation with OpenAPI and @hectoday/http

Your API works, but nobody outside your team knows how to use it. In this course, you'll learn how to document every endpoint, schema, and error using the OpenAPI standard. You'll generate specs from your Zod schemas, serve interactive docs with Swagger UI, generate typed client SDKs, and write tests that keep your docs in sync with your code.

Intermediate ~4 hours

Why documentation

  1. Undocumented APIs are unusable
  2. The OpenAPI standard
  3. Project setup

Describing your API

  1. Paths and operations
  2. Request parameters
  3. Request bodies
  4. Responses

Schemas and reuse

  1. Component schemas
  2. Zod to OpenAPI
  3. Error schemas

Beyond endpoints

  1. Authentication documentation
  2. Tags and grouping
  3. Examples and descriptions

Serving and consuming

  1. Serving the spec
  2. Interactive docs with Scalar
  3. Generating client SDKs

Wrapping up

  1. Versioned specs
  2. Checklist

© 2026 hectoday. All rights reserved.