Introduction ​

Overview ​

Tspec is a library to generate API document from TypeScript types.

It automatically parses your TypeScript types and generates up-to-date OpenAPI Specification with beautiful Swagger UI.

Why tspec? ​

• Code First: Rely on TypeScript type and JSDoc to generate OpenAPI Specification.
• Easy to learn: No need to learn new OpenAPI Spec syntax. Just use TypeScript types.
• Easy to use: Only few lines of code are needed to generate OpenAPI Specification.
• Flexible: You can use any framework you want. It doesn't impose any framework-specific constraints.