swagger
rswag
swagger | rswag | |
---|---|---|
5 | 14 | |
1,609 | 1,892 | |
0.9% | 1.3% | |
9.6 | 7.5 | |
5 days ago | 25 days ago | |
TypeScript | Ruby | |
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
-
Can you tell me what's the difference of using @nestjs/swagger instead of class-validators for DTO validation? thank you
Yeah the API is very similar but they serve different purposes as you mention here. It looks like there's been some discussion about aligning them since other people have had a similar observation.
-
NestJS + esbuild workarounds
1. openapi is not defined. https://github.com/nestjs/swagger/issues/1450
-
decorators
The repository for every optional NestJS package that has decorators seems to consistently put them in /lib/decorators. For example, here are the NestJS Swagger decorators.
-
OpenAPI Specification: The Complete Guide
NestJS provides a dedicated module which allows generating OpenAPI (Swagger) - Github - nestjs/swagger
-
Announcing Ditsmod 2.0 beta (with RealWorld example)
Thanks to the system of extensions, Ditsmod applications are more expressive and with less code. For example, if you compare OpenAPI modules written in Ditsmod and NestJS, the Ditsmod module is 3.5 times smaller in the number of lines of code or the number of files.
rswag
- A Deep Dive into RSpec Tests in Ruby on Rails
-
Generating an OpenAPI/Swagger spec from a Ruby on Rails API
We will be creating a "Coffee Ordering API" using Ruby on Rails, and using a tool called rswag to create tests that verify the behaviour of our API and generate an OpenAPI reference.
-
Build JSON schemas fluently!
Made a library a while back that helped me write JSON schemas for rswag. Hope others find it useful!
-
Documenting Forem's v1 API
Forem, which is a Ruby on Rails app, integrates Swagger via a gem - the rswag gem. The rswag Ruby gem allows us to create a Swagger-based DSL for describing and testing our API operations. It also extends rspec-rails "request specs”, hence, allowing our documentation to be a part of our test suite which allows us to make requests with test parameters and seed data that invoke different response codes. As a result, we are able to test what the requests and responses look like, however we do not test the business logic that drives the endpoint - that is tested elsewhere in the code.
-
How do you document your code?
Using something like rswag will give you some ability, in the specs, to also describe the endpoints and auto-generate some documentation.
-
Is there a way to easily autogenerate API documentation for a Ruby on Rails API?
Hello! I would like to autogenerate API documentation for my Ruby on Rails Application. However, all of the solutions I've found such as https://github.com/rswag/rswag and https://github.com/richhollis/swagger-docs involve writing tests or manually describing the endpoint responses. I am hoping to find something similar to Swashbuckle for ASP.Net Core but for Ruby on Rails. Below is an example of using Swashbuckle's ASP.NET Core to autogenerate Swagger API documentation. The response type is inferred form the return type of the action.
-
I'm a front-end dev currently being asked to work on a Rails API backend. What are some good resources to get comfortable with the language and the framework?
https://github.com/rswag/rswag - helps generate Swagger documentation (you can upload it to an external service, like readme.com or serve from your Rails app)
-
OpenAPI Specification: The Complete Guide
rswag expands the "request specifications" of rspec-rails with a Swagger-based DSL for defining and testing API activities. - Github
-
Looking for a full Rswag example project.
Hello guys, I'm working on a rails (4.x) project, trying to implement a way to create docs for OpenApi 3 and Swagger (I started to learn rails in october last year), this project has like 6 years old, a lot of endpoints and very poor documentation, my first option is Rswag, does anyone knows a good example project for these gem?
-
Help with Rswag + openapi-generator-cli
I'm using the Rswag gem to document my API. Right now I have a WIP here: https://cabal-fintech.herokuapp.com/api-docs/v1/swagger.json but whenever I try to validate it on the swagger validator I get an error not even understandable to me, as that route doesn't need [params].item
What are some alternatives?
springfox - Automated JSON API documentation for API's built with Spring
Apipie - Ruby on Rails API documentation tool
drf-spectacular - Sane and flexible OpenAPI 3 schema generation for Django REST framework.
budibase - Budibase is an open-source low code platform that helps you build internal tools in minutes 🚀
fastapi - FastAPI framework, high performance, easy to learn, fast to code, ready for production
rspec-openapi - Generate OpenAPI schema from RSpec request specs
nestjs-otel - OpenTelemetry (Tracing + Metrics) module for Nest framework (node.js) 🔭
appsmith - Platform to build admin panels, internal tools, and dashboards. Integrates with 25+ databases and any API.
nest-cli - CLI tool for Nest applications 🍹
RDoc - RDoc produces HTML and online documentation for Ruby projects.
realworld - "The mother of all demo apps" — Exemplary fullstack Medium.com clone powered by React, Angular, Node, Django, and many more
Blueprinter - Simple, Fast, and Declarative Serialization Library for Ruby