Blueprinter
rswag
Our great sponsors
Blueprinter | rswag | |
---|---|---|
12 | 14 | |
1,062 | 1,884 | |
1.7% | 1.8% | |
8.8 | 7.8 | |
5 days ago | 18 days ago | |
Ruby | 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.
Blueprinter
-
Recommended Controllers Serializer Gem?
Blueprinter is something we use on a project, it's also having difficulty staying alive, but right now there is active development here, a fork from the original blueprinted gem.
-
Efficient JSON Serialization with Blueprinter for Ruby on Rails
Beware of this
-
Understanding Clean Architecture with small Ruby libraries
Serializer: procore/blueprinter: Simple, Fast, and Declarative Serialization Library for Ruby
-
ActiveModel::Serializer and You
Today I thought I'd run through a few of the powerful things that the ActiveModel::Serializer gem brings to the table when used in a Ruby on Rails application. Sure, there are faster alternatives, but AMS is the first one I learned how to use, and thus it holds a special place in my heart. Quick question before we dive too much deeper, though...
-
What are you using for API JSON serialization in 2022?
Blueprint
-
What are the gems that every Ruby dev should know how to use?
Just an FYI: While I agree that the blueprinter gem is awesome, there are currently no active maintainers: https://github.com/procore/blueprinter/issues/288
-
Hunting down spooky JSON module redefinition via Oj
In a happy coincidence, we're knee-deep in the middle of a migration of our serialisers to use Blueprinter instead of AMS. One benefit, in this case, is that it lets you explicitly set what generator you're using, like so:
-
Accessing [grand+]child through multiple queries VS having direct reference to the [grand+]parent on every model.
What made me think about this is that I'm using (maybe in the wrong way) some gems like Blueprinter and Amoeba.
-
What is the best way to retrieve all instances of a model, along with it's associations, in an index action when using React (or not Rails Views)?
I've been using Blueprinter so far, and it has been working great, but I'd like to ditch it if I can.
-
Looking for a full Rswag example project.
We use it extensively for one project. The only annoying bit involves defining the response json-schema. Luckily we are using a gem called blueprinter for JSON serialization, so we added a bunch of overrides that store metadata, so we can generate the json-schema with meta programming. You might need to find a library that would help you write the schemas fluently [1] / [2] to make it easier to define them.
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?
ActiveModel::Serializers - ActiveModel::Serializer implementation and Rails hooks
Apipie - Ruby on Rails API documentation tool
Fast JSON API - No Longer Maintained - A lightning fast JSON:API serializer for Ruby Objects.
budibase - Budibase is an open-source low code platform that helps you build internal tools in minutes 🚀
jbuilder - Jbuilder: generate JSON objects with a Builder-style DSL
rspec-openapi - Generate OpenAPI schema from RSpec request specs
Rails::API - Rails for API only applications
appsmith - Platform to build admin panels, internal tools, and dashboards. Integrates with 25+ databases and any API.
alba - Alba is a JSON serializer for Ruby, JRuby and TruffleRuby.
RDoc - RDoc produces HTML and online documentation for Ruby projects.
jsonapi-serializer - A fast JSON:API serializer for Ruby (fork of Netflix/fast_jsonapi)
jsonapi-scopes - This gem allows you to filter and sort an ActiveRecord relation based on a request, following the JSON:API specification as closely as possible.