rswag
forem
Our great sponsors
rswag | forem | |
---|---|---|
14 | 197 | |
1,884 | 21,573 | |
1.8% | 0.8% | |
7.8 | 9.8 | |
21 days ago | 4 days ago | |
Ruby | Ruby | |
MIT License | GNU Affero General Public License v3.0 |
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.
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
forem
-
Lesser Known Features of DEV β Embeds!
In the future, I think we will probs make this uniform with the others. I've logged this request here on GitHub... hmmm, maybe I should embed it here instead. π
-
I fixed the "Save draft" Button on dev.to - No Accidental Publishing Anymore π
I even opened a discussion, which got no responses so far (which I think existed somewhere else or I am the only one with this issue...).
-
What are you learning about this weekend? π§
Whether you're sharpening your JS skills, making PRs to your OSS repo of choice π, sprucing up your portfolio, or writing a new post here on DEV, we'd like to hear about it.
-
Tackling Clickbait on DEV: Strategy and Technical Approach
Add articles clickbait_score as factor in final feed ordering #20493
-
Crushing it: My New Year's Resolutions for 2024
Do more documentation-related and code contributions to Forem's repository
-
πΊπΌ My life update and the Open Source #DEVImpact2023
This year again, I contributed to DEV with multiples ways, I've contributed very little to the repository, moderated the bad posts quite a bit, and welcomed newcomers to the platform. I feel that a place like this should always be so welcoming to users, so why shouldn't I?
-
π #DEVImpact2023: A Year of Challenges, Triumphs, and The Future
docs: making updates to Editor Guide #20258
-
Open Source alternatives to tools you Pay for
Forem - Open Source Alternative to Circle
-
What you learning about this weekend? π§
Whether you're sharpening your JS skills, making PRs to your OSS repo of choice π, sprucing up your portfolio, or writing a new post here on DEV, we'd like to hear about it.
-
DEV Community Contributor Spotlight: @joaogabriel55
We like to (loudly!) remind everyone here that the DEV Community is powered by Forem, our community-driven open-source platform. Central to Forem's continuous improvement are the efforts of our dedicated volunteers and we like to highlight those who have gone above and beyond to help out and submit PRs to our repo.
What are some alternatives?
Apipie - Ruby on Rails API documentation tool
Discourse - A platform for community discussion. Free, open, simple.
budibase - Budibase is an open-source low code platform that helps you build internal tools in minutes π
ComfyJS - Comfiest Twitch Chat Library for JavaScript | NodeJS + Browser Support
rspec-openapi - Generate OpenAPI schema from RSpec request specs
klipse - Klipse is a JavaScript plugin for embedding interactive code snippets in tech blogs.
appsmith - Platform to build admin panels, internal tools, and dashboards. Integrates with 25+ databases and any API.
reactor - Phoenix LiveView but for Django
RDoc - RDoc produces HTML and online documentation for Ruby projects.
ghost-on-heroku - One-button Heroku deploy for the Ghost 3.2.0 blogging platform.
Blueprinter - Simple, Fast, and Declarative Serialization Library for Ruby
Ruby on Rails - Ruby on Rails