npmpackage.info

Gathering detailed insights and metrics for tsoa

Other packages similar to tsoa

@tsoa/cli

6.6.0

Build swagger-compliant REST APIs using TypeScript and Node

@tsoa/runtime

6.6.0

Build swagger-compliant REST APIs using TypeScript and Node

tsoa-workers

1.3.6

A add-on for running tsoa on cloudflare workers

@digicatapult/tsoa-oauth-express

0.1.107

Authentication handler for TSOA using OAuth2 JWT tokens

Gathering detailed insights and metrics for tsoa

tsoa

Build OpenAPI-compliant REST APIs using TypeScript and Node

6.6.0

3,719

MIT

TypeScript

1.12 MB

23,371,877 4.6

Installations

npm install tsoa

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Min. Node Version

>=18.0.0

Node Version

22.12.0

NPM Version

lerna/8.1.9/node@v22.12.0+x64 (linux)

Pull Requests

Open

4

Total

642

Closed

128

Merged

510

Issues

Open

122

Total

1,113

Closed

991

Releases

v6.6.0

Updated on Dec 08, 2024

v6.5.0

Updated on Oct 14, 2024

v6.4.0

Updated on Jul 12, 2024

v6.3.1

Updated on Jun 12, 2024

v6.3.0

Updated on Jun 08, 2024

v6.2.1

Updated on Apr 24, 2024

View All 98 releases

Contributors

181

Unable to fetch Contributors

View All 181 Contributors

Languages

TypeScript

Handlebars

JavaScript

TypeScript (96.56%)

Handlebars (2.22%)

JavaScript (1.22%)

validate.email 🚀

Verify real, reachable, and deliverable emails with instant MX records, SMTP checks, and disposable email detection.

Developer

lukeautry

Download Statistics

Total Downloads

23,371,877

Last Day

47,768

Last Week

231,854

Last Month

947,744

Last Year

8,293,081

GitHub Statistics

MIT License

3,719 Stars

1,951 Commits

514 Forks

27 Watchers

28 Branches

181 Contributors

Updated on Mar 14, 2025

Bundle Size

4.06 MB

Minified

1.12 MB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

6.6.0

Package Id

tsoa@6.6.0

Unpacked Size

6.37 kB

Size

3.35 kB

File Count

NPM Version

lerna/8.1.9/node@v22.12.0+x64 (linux)

Node Version

22.12.0

Published on

Dec 08, 2024

Total Downloads

Cumulative downloads

Total Downloads

23,371,877

Last Day

16.6%

47,768

Compared to previous day

Last Week

6.9%

231,854

Compared to previous week

Last Month

24.5%

947,744

Compared to previous month

Last Year

26.4%

8,293,081

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

@tsoa/cli @tsoa/runtime

Dev Dependencies

@types/node typescript

tsoa

Pronounced so·uh

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.

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

9

Security-Policy

Determines if the project has published a security policy.

8

Maintained

Determines if the project is "actively maintained".

5

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

3

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

Score

4.6

/10

Last Scanned on 2025-03-10

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More