AutoswagOpenAPI from TypeScript

Generate OpenAPI documentation from JSDoc comments and TypeScript types. Keep your API docs in sync with your code automatically.

Get Started

View on GitHub

Introduction

🎯

Single Source of Truth

Define types once in TypeScript, reference them in JSDoc. No duplication, no drift between code and documentation.

⚡

TypeScript-First

Automatically converts TypeScript types to OpenAPI schemas. Interfaces, unions, generics, enums - all supported out of the box.

📝

JSDoc Powered

Document endpoints using natural JSDoc comments. Simple syntax, powerful features, stays close to your implementation.

Usage example

import type { User, CreateUserRequest, ErrorResponse } from '@/types/user'

/**
 * @autoswag POST /users
 * @summary Create a new user
 * @tag Users
 * @accept {CreateUserRequest}
 * @response {User} 201 User created successfully
 * @response {ErrorResponse} 400 Invalid input
 * @response 401 Unauthorized
 */
export async function createUser(req, res) {
    // Your implementation here
}

AutoswagOpenAPI from TypeScript

Single Source of Truth

TypeScript-First

JSDoc Powered

Usage example ​

Usage example