switchdreams/rest-api-generator

Build a Ruby on Rails REST API faster

rest-api-generator's Issues

Filtering/Search

Goal

Filter some resource by parameters

/projects?archived=true

Inspirations

# From https://hspazio.github.io/2018/rails-filterable-concern/
module Filterable
  extend ActiveSupport::Concern

  included do
    @search_scopes ||= []
  end

  module ClassMethods
    attr_reader :search_scopes

    def search_scope(name, *args)
      scope name, *args
      @search_scopes << name.to_s.gsub('filter_by_', '').to_sym
    end

    def filter(params)
      results = where(nil)
      params.each do |key, value|
        results = results.public_send("filter_by_#{key}", value) if value.present?
      end
      results
    end
  end
end

• https://hspazio.github.io/2018/rails-filterable-concern/
• https://gist.github.com/mamantoha/9c0aec7958c7636cebef
• https://github.com/heartcombo/has_scope

Serialization

Goal

Support serialization by default

Options

• For AMS: Just use the default generator for creating a serializer object
• Panko Serializer: More perfomatic serializer

Needs

• Config option for choosing another serializer gem

Pagination

Goal

Support pagination

Inspirations

• We can just use this gem by default with Pagy: https://github.com/davidcelis/api-pagination

Automated Documentation

Goal

When generating a new resource, I want to generate automatic documentation too

How?

Using this gem: https://github.com/rswag/rswag

Obs

• Maybe we need some config file to the user select to generate rspec simple specs or rswag specs

Get some ideas from graphiti api

https://www.graphiti.dev/quickstart

Wrong params when created with references

When we run:
rails g rest_api_generator:resource Task student:references

The generated controller params is;

def task_params
  params.require(:task).permit(:student)
end

its is expected to be:

def task_params
  params.require(:task).permit(:student_id)
end

Improves filter resource api

The goals is to reduce when use filter resource function:

Project.filter_resource(params.slice(*Project.filter_scopes)

Most of the time the filter resource argument is params.slice(*Project.filter_scopes), we can setup the default value of filter resource to that

Rswag description always delete plan for any resource

Next steps for this gem

Write in README.md the step for this gems

New error handler module

This actual error handler module does not handle well forms attributes. This approach seens better: https://driggl.com/blog/a/handling-exceptions-in-rails-applications

RSwag support to requests with authentication

Add option to generate rswag specs with bearer token authentication syntax configured

Improves pagination docs

Improves pagination docs with the pagination headers and cors configuration

callbacks for set resource

When we are trying to setup authorization, regularly we need to run a method with the resource as params.

Example with action policy

before_action -> { authorize! @power_plant, with: PowerPlantChildrenPolicy }

i think a good API is:

after_set_resource ->(resource) { authorize! resource, with: PowerPlantChildrenPolicy }

and

after_set_parent_resource ->(resource) { authorize! resource, with: PowerPlantChildrenPolicy }

Draw routes for nested and scoped resources

When we generate a nested or scoped resources this message shows in terminal:

You need to manually setup routes files for nested or scoped resource

But is possible to setup this automatic.

Guides

• https://stackoverflow.com/a/968475/13815168

Improves docs for setup development environment

Setup for testing

Use params types on RSwag specs generation

When creating a rswag spec for a resource with rails g rest_api_generator:spec:rswag Car name:string color:string year:integer, it currently ignores fields types and sets everything as string on params (for post and patch requests).

Sorting/Ordering

Goal

This feature wants to achieve sorting for any field from the resource, example:

http://example.com/articles?sort=+author

Inspiration

• https://gist.github.com/mamantoha/9c0aec7958c7636cebef
• http://example.com/articles?sort=+author,-datepublished

CI for rspec

New docs

Readme.md docs is hard to read and understand, normally in SwitchDreams we use vitepress

Changes spec describe to controller name