Skip to content

介绍

概述

Tspec是一个从TypeScript类型生成API文档的库。

它自动解析TypeScript类型,生成最新的OpenAPI Specification,并通过美观的Swagger UI提供。

为什么选择Tspec?

  • Code First: 基于TypeScript类型和JSDoc生成OpenAPI Specification。
  • 易于学习: 无需学习新的OpenAPI规范语法,只需使用TypeScript类型。
  • 易于使用: 只需几行代码即可生成OpenAPI Specification。
  • 灵活性: 可以使用任何框架,不受框架限制。
  • 开箱即用: 原生支持CommonJS和ESM。无需转译器(ts-node、babel、swc)。