Tsoa NPM | npm.io

6.5.1 • Published 9 months ago

Install

Weekly downloads

38,622

License

MIT

Repository

Last release

9 months ago

OpenAPI-compliant REST APIs using TypeScript and Node

Goal

TypeScript controllers and models as the single source of truth for your API
A valid OpenAPI (formerly Swagger) spec (2.0 or 3.0 if you choose 😍) is generated from your controllers and models, including:
- Paths (e.g. GET /users)
- Definitions based on TypeScript interfaces (models)
- Parameters/model properties marked as required or optional based on TypeScript (e.g. myProperty?: string is optional in the OpenAPI spec)
- jsDoc supported for object descriptions (most other metadata can be inferred from TypeScript types)
Routes are generated for middleware of choice
- Express, Hapi, and Koa currently supported, other middleware can be supported using a simple handlebars template
- Validate request payloads

Philosophy

Rely on TypeScript type annotations to generate API metadata if possible
If regular type annotations aren't an appropriate way to express metadata, use decorators
Use jsdoc for pure text metadata (e.g. endpoint descriptions)
Minimize boilerplate
Models are best represented by interfaces (pure data structures), but can also be represented by classes
Runtime validation of tsoa should behave as closely as possible to the specifications that the generated OpenAPI 2/3 schema describes. Any differences in validation logic are clarified by logging warnings during the generation of the OpenAPI Specification (OAS) and/or the routes.
- Please note that by enabling OpenAPI 3 you minimize the chances of divergent validation logic since OpenAPI 3 has a more expressive schema syntax.

Getting Started

Examples

Check out the guides

See example controllers in the tests

See example models in the tests

Help wanted

Contributing code

To contribute (via a PR), please first see the Contributing Guide

Becoming a maintainer

tsoa wants additional maintainers! The library has increased in popularity and has quite a lot of pull requests and issues. Please post in this issue if you're willing to take on the role of a maintainer.

typescript openapi swagger server node node.js codegen generation express hapi.js koa

@tsoa/cli @tsoa/runtime

pioneer-rest-ts dua-chat identity-ws wholesale-forwarding friesensport-ergebnisdienst-shared @infinitebrahmanuniverse/nolb-tso @everything-registry/sub-chunk-2982 namaste-be svetch.ts spokenio-api test-this-module validate-error-tsoa-woowfix @credo-ts/rest @coopenomics/controller @dolittle/vanir-backend cd-monitor tsoa-jsdom-workers-example tsoa-loader tsoa-routing-controllers tsoa-serverless tsoa-webpack-plugin tsoa_sample time-negar tms-customer-portal-api userservicewecare @aries-framework/rest @affinidi/affinity-common-backend @algotia/server @bird-wp07/local-module @bithighlander/keepkey-bridge unif-domain-template @fragcolor/dk @fragcolor/sdk @leafgistics/common @lordoftheflies/paspartu-erp-backend @itsarisid/harmony @mush-ko-li/leapp-core-nightly @ercdex/cli @ercdex/mm @kendallroth/starter-kit-api @interlay/polkabtc-stats @kazize/create-ts-starter-1 @noovolari/leapp-core @noovolari/leapp-core-nightly @scaffoldly/serverless-util @ron96/connector senomas-micro-lib senomas-micro-sql-lib radarsu radarsu-core idf-kivia-mka-back-for-front mdjotter leadcast-public-rest-api @xen-orchestra/rest-api @typeshield/http @threefoldjimber/digitaltwin-backend @uniflow-io/uniflow-api @topgroup/diginext backend-package-typescrypt cds.email-subscription contecst create-express-typescript-application-sample bcx-eco-system-libary bankless-api baldbot dgp-xp-app dguardcloudbe dxpllm-quote example-server-tsoa express-mongo-model @shapeshiftoss/bitcoin-api @shapeshiftoss/common-api @shapeshiftoss/ethereum-api @shodement/microservice @squiz/render-runtime-lib @squiz/edge-dev-render-runtime-lib @squiz/management-api @squidcloud/local-backend @squidcloud/backend

9 months ago

9 months ago

1 year ago

1 year ago

12 months ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3 years ago

3 years ago

3 years ago

3 years ago

2 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

4 years ago

4 years ago

3 years ago

3 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago