swagger-jsdoc
tsoa
swagger-jsdoc | tsoa | |
---|---|---|
8 | 16 | |
1,642 | 3,136 | |
1.0% | - | |
1.5 | 9.1 | |
about 1 month ago | 4 days ago | |
JavaScript | TypeScript | |
MIT License | MIT License |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
swagger-jsdoc
-
Best DX to write OpenAPI documentation
For this task, we are going to use swagger-jscode. It says that it is to write Swagger, old name of OpenAPI, inside jsdoc, like below
- How do i document my api ?
-
NodeJS API Documentation
js doc style comments support
-
Automatic swagger ui for nodejs/express? (Info in comments)
There's swagger-ui-express which can work with swagger-jsdoc.
-
Do you use Swagger/OpenAPI to document your APIs? If so, what is your preferred way to generate the docs?
If so, how do you go about generating the interface files? I recently discovered swaggo which generates OpenAPI docs from Go annotations. My Googlefoo then led me to swagger-jsdoc and openapi-comment-parser which do the same thing from JSdoc-like comments. Do you use them, do you use some other module, or do you use some other approach entirely?
-
How do you create API's for front end engineers?
Express by itself lacks a lot of metadata useful for generating OpenAPI spec, you'll end up writing a lot of non-standard doc comments. You want to use something like swagger-jsdoc to generate the spec and then some other package to generate the UI.
-
Adding a Swagger UI page to your Express REST API
This article is a continuation of a series about how to build a REST API in Node.js. In the preceding article of this series we added request and response validation that is based on an OpenAPI spec of the API. We used the swagger-jsdoc package to generate this OpenAPI spec from comments in our code that annotate the REST operations.
-
Adding request and response validation to your Express REST API
The swagger-jsdoc package enables us to do this. It looks for JSDoc comments in code (annotated with an @openapi tag) to generate the OpenAPI specification.
tsoa
-
Create Production-Ready SDKs with Goa
Tsoa is a popular TypeScript framework similar to Goa that you may encounter in the OpenAPI ecosystem. Speakeasy has a tutorial for it, too.
- JavaScript Gom Jabbar
-
Choosing a backend API framework
Currently i am using TSOA and loving it, it gives you automatic Open API specs and data validation based on typescript interfaces. I have used Nest on previous projects but I personally don't like the decorators hell that comes with Nest, and raw express/fastify are ok and easy to use but a pain in the ass on big projects to keep swagger, validations, interfaces and DTOs all in sync.
-
Does anyone here have any experience with TSOA? (tool for OpenAPI-compliant REST APIs using TypeScript and Node)
I'm curious if anyone here has played around with or used TSOA (https://github.com/lukeautry/tsoa)?
-
Is Express.js a good idea for backend?
If you decide to go with Express/Typescript I would definitely check out TSOA. It's a nice way to build backend APIs with auto documentation.
-
Swagger without express or koa or etc
We are using TSOA to generate the docs from the code, works pretty well. https://github.com/lukeautry/tsoa
-
OpenAPI Generator allows generation of API client libraries from OpenAPI Specs
This is the best project I’ve found to that for that - https://github.com/lukeautry/tsoa. Uses decorators mainly.
If there are other such projects, please share.
-
TypeScript-based REST API template to quickly bootstrap your next project
Hello, In the last month I built a REST API template in Typescript to quickly bootstrap new projects, I tried to use the most updated modules available, I've also included a "todo" sample just to showcase how all the things work together, the main modules that I've used are: - expressjs + tsoa that allows to easily generate the OpenAPI spec without any additional steps (just declare your controllers via typescript) - class-validator to validate body requests (this is also useful as the OpenAPI will be automatically generated based on the classes that you define) - Jest for testing, I've included also unit and integrations test samples with an in-memory database
-
Automatic swagger ui for nodejs/express? (Info in comments)
Have a look at [TSOA[(https://github.com/lukeautry/tsoa). While far from perfect (I am on the lookout to find a better solution), gets the job done. And generating the entire routing is a pretty neat trick, so that's also that.
-
How popular is typescript in backend development?
tsoa Lighter weight, but also great.
What are some alternatives?
swagger-ui-express - Adds middleware to your express app to serve the Swagger UI bound to your Swagger document. This acts as living documentation for your API hosted from within your app.
Nest - A progressive Node.js framework for building efficient, scalable, and enterprise-grade server-side applications with TypeScript/JavaScript 🚀
express-openapi-validator - 🦋 Auto-validates api requests, responses, and securities using ExpressJS and an OpenAPI 3.x specification
Express - Fast, unopinionated, minimalist web framework for node.
fastify-openapi-glue - A plugin for the Fastify webserver to autogenerate a Fastify configuration based on a OpenApi(v2/v3) specification.
JSDoc - An API documentation generator for JavaScript.
Koa - Expressive middleware for node.js using ES2017 async functions
routing-controllers - Create structured, declarative and beautifully organized class-based controllers with heavy decorators usage in Express / Koa using TypeScript and Routing Controllers Framework.
fastify-swagger - Swagger documentation generator for Fastify
Hapi - The Simple, Secure Framework Developers Trust