@tsoa/cli is a command-line interface for the TSOA framework, which is used to generate TypeScript-based REST APIs with OpenAPI documentation. It helps in creating controllers, models, and routes, and also generates OpenAPI specifications from TypeScript code.
Generate OpenAPI Specification
This command generates the OpenAPI specification (swagger.json) from your TypeScript code. It scans your controllers and models to create a comprehensive API documentation.
tsoa specGenerate Routes
This command generates the routes for your API based on the controllers defined in your TypeScript code. It creates a routes file that can be used to set up your API endpoints.
tsoa routesWatch Mode
This command runs both the 'spec' and 'routes' commands in watch mode. It automatically regenerates the OpenAPI specification and routes whenever there are changes in your TypeScript files.
tsoa spec-and-routes --watchswagger-jsdoc is a package that allows you to integrate JSDoc comments in your JavaScript code to generate OpenAPI (Swagger) documentation. Unlike @tsoa/cli, which is TypeScript-focused, swagger-jsdoc is more suited for JavaScript projects.
express-openapi is a package that helps you build APIs with OpenAPI documentation in an Express.js environment. It provides a way to define your API using OpenAPI definitions and automatically generates routes. It is similar to @tsoa/cli but is more focused on Express.js and JavaScript.
This package contains the tsoa build time components.
For a comprehensive Readme, please refer to the main readme.
FAQs
Build swagger-compliant REST APIs using TypeScript and Node
The npm package @tsoa/cli receives a total of 136,255 weekly downloads. As such, @tsoa/cli popularity was classified as popular.
We found that @tsoa/cli demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.