rswag VS craft.js

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.

Made a library a while back that helped me write JSON schemas for rswag. Hope others find it useful!

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.

Using something like rswag will give you some ability, in the specs, to also describe the endpoints and auto-generate some documentation.

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.

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)

rswag expands the "request specifications" of rspec-rails with a Swagger-based DSL for defining and testing API activities. - Github

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?

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

I've been building one with https://craft.js.org/ , tailwind, nextjs, and vercel, a few months into it I've got a decent component library, custom domains, subdomains, static pages, accounts, multiple pages, cdn and a bit more. The basics are easy to get going. Making it easy to understand/use, responsive, and all that, is a bit more complex.

As for the second part of your question, regarding UI. Reka is purely the state management system, so it is designed to help with storing/editing user content and computing an output for that content so you can render that on the browser; it’s not really responsible for the UI part. For building UI’s for your page editor - there’s Craft.js which is another framework that I built for creating page editors. Craft comes with an event system that lets you know which elements is being selected/hovered/dragged and a drag and drop system that lets you move elements around on the screen along with other things that helps you build your own page editor UI. Craft is actually the parent project of Reka. Reka was built to replace Craft’s internal state management system so that you could build entire UI components in Craft in the future. If you’re interested, you could check out the motivation and relationship between Craft and Reka here. As for the demo shown in the video, all the UI interactions (including some that you have mentioned like showing the borders of selected elements) are fairly straightforward, and they’re simply just interacting/mutating the AST state of Reka. Feel free to take a look at the code for the demo.

https://craft.js.org/ - This is probably more like what you're looking for. It's in heavy development still and does lack some features but you can use it with reactive components.

We’ve been looking into craftjs for this use case since it seems to be more targeted at letting you build on top of it. https://craft.js.org/

Does anyone have some recommendations? https://craft.js.org/ something like this, but not with HTML.

i think that's how all no-code web editors like carrd, webflow, squarespace work i think (see https://github.com/prevwong/craft.js & https://github.com/artf/grapesjs)

If you're just talking about a WYSIWYG website page editor, check out https://github.com/prevwong/craft.js