6.2.1 • Published 1 day ago

tsoa v6.2.1

Weekly downloads
38,622
License
MIT
Repository
github
Last release
1 day ago

OpenAPI-compliant REST APIs using TypeScript and Node

build status npm version

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.

typescriptopenapiswaggerservernodenode.jscodegengenerationexpresshapi.jskoa
@tsoa/cli@tsoa/runtime
pioneer-rest-tsdua-chatidentity-wswholesale-forwardingfriesensport-ergebnisdienst-shared@infinitebrahmanuniverse/nolb-tso@everything-registry/sub-chunk-2982dxpllm-quote@scaffoldly/serverless-util@shodement/microservice@shapeshiftoss/bitcoin-api@shapeshiftoss/common-api@shapeshiftoss/ethereum-api@lordoftheflies/paspartu-erp-backend@noovolari/leapp-core-nightly@noovolari/leapp-coretest-this-module@squiz/management-api@squiz/render-runtime-lib@squidcloud/local-backenddguardcloudbedgp-xp-appuserservicewecaretime-negartsoa-loadertsoa-routing-controllerstsoa-serverlesstsoa-webpack-plugintsoa_sampletsoa-jsdom-workers-examplenamaste-be@ron96/connector@threefoldjimber/digitaltwin-backendmdjotterunif-domain-template@bird-wp07/local-module@bithighlander/keepkey-bridge@affinidi/affinity-common-backend@algotia/server@uniflow-io/uniflow-api@topgroup/diginext@dolittle/vanir-backend@aries-framework/restradarsuradarsu-core@typeshield/http@fragcolor/dk@fragcolor/sdkcreate-express-typescript-application-samplecds.email-subscription@interlay/polkabtc-statsbaldbotbackend-package-typescryptbcx-eco-system-libary@credo-ts/restbankless-apisenomas-micro-libsenomas-micro-sql-lib@ercdex/cli@ercdex/mmspokenio-api@itsarisid/harmonycontecst@kendallroth/starter-kit-api@mush-ko-li/leapp-core-nightly@leafgistics/common
6.2.1

1 day ago

6.2.0

1 month ago

6.1.5

1 month ago

6.1.2

2 months ago

6.1.1

2 months ago

6.1.4

1 month ago

6.1.3

2 months ago

6.1.0

2 months ago

6.0.1

3 months ago

6.0.0

4 months ago

6.0.0-rc.5

5 months ago

6.0.0-rc.1

10 months ago

6.0.0-rc.4

7 months ago

6.0.0-rc.3

9 months ago

6.0.0-rc.2

9 months ago

6.0.0-rc.0

1 year ago

5.1.1

1 year ago

5.1.0

1 year ago

5.0.0-alpha.5

1 year ago

5.0.0-alpha.4

1 year ago

5.0.0-rc.0

1 year ago

5.0.0-alpha.3

1 year ago

5.0.0

1 year ago

5.0.0-alpha.2

2 years ago

5.0.0-alpha.1

2 years ago

5.0.0-alpha.0

2 years ago

4.1.3

2 years ago

4.1.2

2 years ago

4.1.0

2 years ago

4.1.1

2 years ago

4.0.0

2 years ago

4.0.0-rc.1

2 years ago

4.0.0-rc.2

2 years ago

4.0.0-alpha.1

2 years ago

4.0.0-alpha.2

2 years ago

4.0.0-rc.0

2 years ago

4.0.0-beta.0

2 years ago

4.0.0-alpha.0

2 years ago

3.14.1

2 years ago

3.14.0

2 years ago

3.12.0

3 years ago

3.13.0

3 years ago

3.11.2

3 years ago

3.11.1

3 years ago

3.11.0

3 years ago

3.10.0

3 years ago

3.9.0

3 years ago

3.8.0

3 years ago

3.7.0

3 years ago

3.6.1

3 years ago

3.6.0

3 years ago

3.5.2

3 years ago

3.5.1

3 years ago

3.5.0

3 years ago

3.4.0

4 years ago

3.3.0

4 years ago

3.3.0-alpha.0

4 years ago

3.2.1

4 years ago

3.2.0

4 years ago

3.1.1

4 years ago

3.1.0

4 years ago

3.0.8

4 years ago

3.0.7

4 years ago

3.0.6

4 years ago

3.0.5

4 years ago

2.5.14

4 years ago

3.0.4

4 years ago

3.0.3

4 years ago

3.0.2

4 years ago

2.5.13

4 years ago

3.0.1

4 years ago

2.5.12

4 years ago

3.0.0

4 years ago

2.5.11

4 years ago

2.5.10

4 years ago

2.5.9

4 years ago

2.5.8

4 years ago

2.5.7

5 years ago

2.5.6

5 years ago

2.5.5

5 years ago

2.5.4

5 years ago

2.5.3

5 years ago

2.5.2

5 years ago

2.5.1

5 years ago

2.5.0

5 years ago

2.4.11

5 years ago

2.4.10

5 years ago

2.4.9

5 years ago

2.4.8

5 years ago

2.4.7

5 years ago

2.4.6

5 years ago

2.4.5

5 years ago

2.4.4

5 years ago

2.4.3

5 years ago

2.4.2

5 years ago

2.4.1

5 years ago

2.4.0

5 years ago

2.3.81

5 years ago

2.3.8

5 years ago

2.3.7

5 years ago

2.3.6

5 years ago

2.3.5

5 years ago

2.3.4

5 years ago

2.3.3

5 years ago

2.3.2

5 years ago

2.3.1

5 years ago

2.3.0

5 years ago

2.2.5

6 years ago

2.2.4

6 years ago

2.2.3

6 years ago

2.2.2

6 years ago

2.2.1

6 years ago

2.2.0

6 years ago

2.1.8

6 years ago

2.1.7

6 years ago

2.1.6

6 years ago

2.1.5

6 years ago

2.1.4

6 years ago

2.1.3

6 years ago

2.1.2

6 years ago

2.1.1

6 years ago

2.1.0

6 years ago

2.0.2

6 years ago

2.0.1

7 years ago

1.3.6

7 years ago

1.3.5

7 years ago

1.3.4

7 years ago

1.3.3

7 years ago

1.3.2

7 years ago

1.3.1

7 years ago

1.3.0

7 years ago

1.2.2

7 years ago

1.1.8

7 years ago

1.1.7

7 years ago

1.1.6

7 years ago

1.1.5

7 years ago

1.1.4

7 years ago

1.1.3

7 years ago

1.1.2

7 years ago

1.1.1

7 years ago

1.1.0

7 years ago

1.0.19

7 years ago

1.0.18

7 years ago

1.0.17

7 years ago

1.0.16

7 years ago

1.0.15

7 years ago

1.0.14

7 years ago

1.0.13

7 years ago

1.0.12

7 years ago

1.0.11

7 years ago

1.0.10

7 years ago

1.0.9

7 years ago

1.0.8

7 years ago

1.0.7

7 years ago

1.0.6

7 years ago

1.0.5

7 years ago

1.0.4

7 years ago

1.0.3

7 years ago

1.0.2

7 years ago

1.0.1

7 years ago

1.0.0

8 years ago

0.0.63

8 years ago

0.0.62

8 years ago

0.0.61

8 years ago

0.0.60

8 years ago

0.0.59

8 years ago

0.0.58

8 years ago

0.0.56

8 years ago

0.0.55

8 years ago

0.0.54

8 years ago

0.0.52

8 years ago

0.0.51

8 years ago

0.0.50

8 years ago

0.0.49

8 years ago

0.0.48

8 years ago

0.0.47

8 years ago

0.0.46

8 years ago

0.0.45

8 years ago

0.0.44

8 years ago

0.0.43

8 years ago

0.0.42

8 years ago

0.0.41

8 years ago

0.0.40

8 years ago

0.0.39

8 years ago

0.0.38

8 years ago

0.0.37

8 years ago

0.0.36

8 years ago

0.0.35

8 years ago

0.0.34

8 years ago

0.0.33

8 years ago

0.0.32

8 years ago

0.0.31

8 years ago

0.0.30

8 years ago

0.0.29

8 years ago

0.0.28

8 years ago

0.0.27

8 years ago

0.0.26

8 years ago

0.0.25

8 years ago

0.0.24

8 years ago

0.0.23

8 years ago

0.0.22

8 years ago