swagger-jsdoc
foal
| swagger-jsdoc | foal | |
|---|---|---|
| 8 | 16 | |
| 1,642 | 1,857 | |
| 1.0% | 0.2% | |
| 1.5 | 9.0 | |
| about 1 month ago | 9 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.
foal
- FoalTS – A Full-Featured Node.js Framework
- FoalTS 3.0 released – TypeScript app framework
-
Foal version 3.0 is here 🚀
Version 3.0 of Foal is finally there!
-
Foal v2.11 has been released with better password management
Version 2.11 of Foal is out! Here are the improvements that it brings:
-
nodejs frameworks
I'm a fan of FoalTS
-
Version 2.10 of Foal is out!
Version 2.10 of Foal is out! This small release brings some tiny improvements.
-
FoalTS 2022 survey is open!
FoalTS 2022 survey is now open (yes, a few months late 🙃)!
-
Do you use Swagger/OpenAPI to document your APIs? If so, what is your preferred way to generate the docs?
FoalTS allows you to generate your OpenAPI documentation directly from your code: https://foalts.org/docs/api-section/openapi-and-swagger-ui.
-
FoalTS framework - Version 2.9 is here 🎉
Original publication: https://foalts.org/blog/2022/05/29/version-2.9-release-notes
-
From Node to Ruby on Rails
I would guess commodity plumbing. There's a lot of work you have to do to get something like express on par with Rails or any other Rails inspired framework for which there are many in multiple languages even in nodejs.
imo the one I like best in nodejs is Blitzjs https://blitzjs.com/
FoalTS https://foalts.org/ is nice too and there are several other full stack frameworks like Nestjs, FeatherJs, and redwoodjs
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
AdonisJs Framework - AdonisJS is a TypeScript-first web framework for building web apps and API servers. It comes with support for testing, modern tooling, an ecosystem of official packages, and more.
fastify-openapi-glue - A plugin for the Fastify webserver to autogenerate a Fastify configuration based on a OpenApi(v2/v3) specification.
nestjs-boilerplate - NestJS boilerplate. Auth, TypeORM, Mongoose, Postgres, MongoDB, Mailing, I18N, Docker.
JSDoc - An API documentation generator for JavaScript.
feathers - The API and real-time application framework
routing-controllers - Create structured, declarative and beautifully organized class-based controllers with heavy decorators usage in Express / Koa using TypeScript and Routing Controllers Framework.
litegraph.js - A graph node engine and editor written in Javascript similar to PD or UDK Blueprints, comes with its own editor in HTML5 Canvas2D. The engine can run client side or server side using Node. It allows to export graphs as JSONs to be included in applications independently.
fastify-swagger - Swagger documentation generator for Fastify
million - Optimize React performance and make your React 70% faster in minutes, not months.