Add apipie gem

Author: Eugeny Khlopin

Gemfile

@@ -11,6 +11,8 @@ gem 'bootsnap', '>= 1.1.0', require: false
 gem 'search_object'
 gem 'search_object_graphql'
 
+gem 'apipie-rails'
+
 group :development, :test do
   gem 'faker'
   gem 'byebug', platforms: %i[mri mingw x64_mingw]

Gemfile.lock

@@ -50,6 +50,8 @@ GEM
     annotate (2.7.4)
       activerecord (>= 3.2, < 6.0)
       rake (>= 10.4, < 13.0)
+    apipie-rails (0.5.15)
+      rails (>= 4.1)
     arel (9.0.0)
     ast (2.4.0)
     bootsnap (1.3.2)
@@ -212,6 +214,7 @@ PLATFORMS
 DEPENDENCIES
   active_model_serializers
   annotate
+  apipie-rails
   bootsnap (>= 1.1.0)
   byebug
   database_cleaner

app/controllers/api/v1/books_controller.rb

@@ -8,15 +8,35 @@ class BooksController < ApplicationController
 
       before_action :set_book, only: %i[show update destroy]
 
+      def_param_group :book do
+        param :id, :number, desc: 'Id of book', required: true
+        param 'book[title]', String, desc: 'Title of book', required: true, only_in: :request
+        param 'book[description]', String, desc: 'Description of book', only_in: :request
+        property :title, String,   desc: 'Title of book'
+        property :descriprion, String,   desc: 'Description of book'
+        property :created_at, String,   desc: 'Date of book creation'
+        property :updated_at, String,   desc: 'Date of book update'
+      end
+
+      api :GET, '/books/', 'Shows all books'
+      returns array_of: :book, code: 200, desc: 'All books'
       def index
         books = Book.all
         render json: books
       end
 
+      api :GET, '/books/:id', 'Shows the requested book'
+      param :id, :number, desc: 'Id of the book', required: true
+      returns :book, code: 200, desc: 'Requested book'
+      error code: 404, desc: 'Not Found'
       def show
         render json: @book
       end
 
+      api :POST, '/books/', 'Create a new book'
+      returns :book, code: 200, desc: 'Created book'
+      param_group :book
+
       def create
         book = Book.new(book_params)
         if book.save
@@ -26,6 +46,10 @@ def create
         end
       end
 
+      api :PUT, '/books/:id', 'Updates the requested book'
+      param_group :book
+      returns :book, code: 200, desc: 'Updated book'
+      error code: 404, desc: 'Not Found'
       def update
         if @book.update(book_params)
           render json: @book, status: :ok
@@ -34,6 +58,9 @@ def update
         end
       end
 
+      api :DELETE, '/books/:id', 'Deletes the requested book'
+      returns code: 200
+      param :id, :number, desc: 'Id of the book', required: true
       def destroy
         @book.destroy
       end

config/initializers/apipie.rb

@@ -0,0 +1,8 @@
+Apipie.configure do |config|
+  config.app_name                = "Api Documentation"
+  config.api_base_url            = "/api/v1"
+  config.doc_base_url            = "/apipie"
+  # where is your API defined?
+  config.api_controllers_matcher = "#{Rails.root}/app/controllers/api/**/*.rb"
+  config.translate = false
+end

config/routes.rb

@@ -1,5 +1,7 @@
 Rails.application.routes.draw do
 
+  apipie unless Rails.env.production? 
+  
   namespace :api do
     namespace :v1 do
       resources :authors