swagger-jsdoc
openapi-typescript
swagger-jsdoc | openapi-typescript | |
---|---|---|
8 | 17 | |
1,642 | 4,591 | |
1.0% | - | |
1.5 | 9.3 | |
about 1 month ago | 7 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.
openapi-typescript
- TypeSpec: A New Language for API-Centric Development
-
Writing type safe API clients in TypeScript
OpenAPI TypeScript
-
Django 5.0 Is Released
I'll preface all of this with a couple esoteric design goals that I had in mind:
1. I actually _want_ an SPA. You might not need an SPA, if you don't need one then Vue/React/etc are overkill, etc.
2. I want to power as much of the SPA as I can using the same REST API as my core product, both for dogfooding reasons and for consolidation. Many people might argue that this is a bad idea.
---
With that in mind, some specific packages that I highly recommend:
1. Django-vite (https://github.com/MrBin99/django-vite). This makes it very easy to serve an SPA from the actual django response/request model
2. Some sort of way to get type information (if you're using TypeScript) into the frontend. I use a frankensteined system of the OpenAPI spec that django-ninja generates + openapi-typescript (https://github.com/drwpow/openapi-typescript). This means when I add, say, a new field to a response in Django, I immediately get typechecking for it in Vue — which has been _tremendously_ useful.
3. Django-typescript-routes (a package I extracted and open-sourced!: https://github.com/buttondown-email/django-typescript-routes) which gives your front-end routing information based on the Django router.
- OpenAPI-TypeScript – OpenAPI schemas in TypeScript
-
Tell HN: Postman just wiped all my stuff
Glad to see alternatives but disappointed that Bruno does not support OpenAPI specification.
At my company, we hand-edit OpenAPI specs in YAML and it gets consumed by many tools that generate types[0], static analysis and dynamic checks[1]. The OpenAPI spec itself is linted[2]. And of course, Postman consumes OpenAPI.
Tools that are built on open standards will naturally see greater adoption over those that use proprietary formats.
[0]: https://openapi-ts.pages.dev
-
tRPC – Move Fast and Break Nothing. End-to-end typesafe APIs made easy
Another great library to generate TS types from OpenAPI is https://github.com/drwpow/openapi-typescript . It provides the types as single objects you access via indexing, which is pretty nice. There's a partner library to generate a typed fetch client.
-
How can I generate typescript types?
If you're willing to document your API with an OpenAPI schema, then it should be possible to generate TypeScript types based on the OpenAPI schema with something like openapi-typescript. Also, Typebox can generate JSON schemas, maybe it can be used to generate something that the front-end can also use?
-
Should I add Redux?
REST
-
Building a Secure Database-Centric OpenAPI in 15 Minutes
In this sample, we'll achive it using openapi-typescript and openapi-typescript-fetch.
- GRPC Gateway API Client?
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.
routing-controllers - Create structured, declarative and beautifully organized class-based controllers with heavy decorators usage in Express / Koa using TypeScript and Routing Controllers Framework.
express-openapi-validator - 🦋 Auto-validates api requests, responses, and securities using ExpressJS and an OpenAPI 3.x specification
remult - Full-stack CRUD, simplified, with SSOT TypeScript entities
fastify-openapi-glue - A plugin for the Fastify webserver to autogenerate a Fastify configuration based on a OpenApi(v2/v3) specification.
proposal-decorators - Decorators for ES6 classes
JSDoc - An API documentation generator for JavaScript.
zod - TypeScript-first schema validation with static type inference
nestjs-openapi3 - OpenAPI 3.x document generation and serving for NestJS.
fastify-swagger - Swagger documentation generator for Fastify
nestjs-auth - Comprehensive handling of authentication and authorization for NestJS.