swagger-jsdoc
swag
swagger-jsdoc | swag | |
---|---|---|
8 | 36 | |
1,642 | 9,812 | |
1.0% | 1.8% | |
1.5 | 8.1 | |
about 1 month ago | 6 days ago | |
JavaScript | Go | |
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.
swag
-
Seeking Advice on the Best Swagger Generation Approach for REST API
Hey Gophers, I'm exploring Swagger generation for a REST API in Go (using go-chi). Currently, I'm testing https://github.com/swaggo/swag/, but I'm uncertain if it's the optimal solution. What are your thoughts or recommendations?
- Como deixar o Swagger com tema dark mode usando Swaggo e Golang
-
Building RESTful API with Hexagonal Architecture in Go
Swaggo is a tool that creates Swagger documentation for Go APIs. It makes documenting API endpoints easier, helping developers understand and use the API.
-
go-ecommerce-microservices: A practical e-commerce microservices, built with cqrs, event sourcing, vertical slice architecture, event-driven architecture.
Some of the features: - ✅ Using Vertical Slice Architecture as a high level architecture - ✅ Using Event Driven Architecture on top of RabbitMQ Message Broker with a custom [Event Bus](pkg/messaging/bus/) - ✅ Using Event Sourcing in Audit Based services like [Orders Service](services/orders/) - ✅ Using CQRS Pattern and Mediator Patternon top of Go-MediatR library - ✅ Using Dependency Injection and Inversion of Controlon top of uber-go/fx library - ✅ Using RESTFul api with Echo framework and using swagger with swaggo/swag library - ✅ Using Postgres and EventStoreDB to write databases with fully supports transactions(ACID) - ✅ Using MongoDB and Elastic Search for read databases (NOSQL) - ✅ Using OpenTelemetry for collection Distributed Tracing with using Jaeger and Zipkin - ✅ Using OpenTelemetry for collection Metrics with using Prometheus and Grafana - ✅ Using Unit Test for testing small units with mocking dependent classes and using Mockery for mocking dependencies - ✅ Using End2End Test and Integration Test for testing features with all of their real dependeinces using docker containers (cleanup tests) and testcontainers-go library
-
OpenAPI v4 Proposal
[1]https://github.com/swaggo/swag/issues/386
-
[Request] Library Recommendation for Auto Swagger/OpenAPIv3 Documentation
I used this the other day and found it very easy to set up: https://github.com/swaggo/swag
-
Public API documentation. What to use?
I use the fizz for developing my webservices + docs, it's smooth! There is swaggo but I don`t like it because the source code get dirty (lots of comments)
-
Any Working Example for Swagger integartion with golang?
You can use swaggo/swag with code annotations
- Change host in Swagger API
-
Swagger codegen or custom tool
checkout swaggo/swag.
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.
GoSwagger - Swagger 2.0 implementation for go
express-openapi-validator - 🦋 Auto-validates api requests, responses, and securities using ExpressJS and an OpenAPI 3.x specification
gin-swagger - gin middleware to automatically generate RESTful API documentation with Swagger 2.0.
fastify-openapi-glue - A plugin for the Fastify webserver to autogenerate a Fastify configuration based on a OpenApi(v2/v3) specification.
fiber-swagger - fiber middleware to automatically generate RESTful API documentation with Swagger 2.0.
JSDoc - An API documentation generator for JavaScript.
Nginx Proxy Manager - Docker container for managing Nginx proxy hosts with a simple, powerful interface
routing-controllers - Create structured, declarative and beautifully organized class-based controllers with heavy decorators usage in Express / Koa using TypeScript and Routing Controllers Framework.
echo-swagger - echo middleware to automatically generate RESTful API documentation with Swagger 2.0.
fastify-swagger - Swagger documentation generator for Fastify
jaeger - CNCF Jaeger, a Distributed Tracing Platform