KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #typescript #developer-tools #claude-code #ai-agent #codex #deepseek-harness #ai-agents #cli #react #mcp

rails5-grape-api-example

★ 30 Open GitHub ↗

Rails 5 + Grape API

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

Rails 5 + Grape API Example
===========================

This is an example application using [Rails 5](http://rubyonrails.org/) + [Grape API](https://github.com/ruby-grape/grape)

# Getting Started

1. Clone the repo

```
   $ git clone https://github.com/gagoit/rails5-grape-api-example.git
   $ cd rails5-grape-api-example
   ```

2. Install dependencies

```
   $ bundle install
   ```

3. Watch the specs pass

```
   $ bin/rspec spec/api
   ... 0 failures
   ```

# Dependencies:
* Ruby version: 2.3.1
* Rails version: 5.0

# Features
## Utilize CORS (Cross-Origin Resource Sharing)
I use the [rack-cors gem!](https://github.com/cyu/rack-cors). This gem provides Rack CORS Middleware to our Rails app, allowing it to support cross-origin resource sharing.

## Serializing
[Grape::ActiveModelSerializers](https://github.com/ruby-grape/grape-active_model_serializers)

## Grape Swagger
The [grape-swagger gem](https://github.com/tim-vandecasteele/grape-swagger) autogenerates Swagger-compliant documentation for your Grape API.

* Visit http://petstore.swagger.io/ and paste http://localhost:3000/api/v1/swagger_doc.json to explore the API.

## Versioning
Api Version will be set in headers['Accept'] = "application/vnd.#{vendor}-v#{version}"

## Authorization
User Authorization token will be set in headers['Authorization']

# Response format:    
## Normal
  ```
  {
     data: {},
     meta: {
        code: 200,
        message: "success"
     }
  }
  ```

## Pagination:
  ```
  {
     data: {},
     meta: {
        code: 200,
        message: "success",
        current_page: 1,
        next_page: 2,
        prev_page: -1,
        total_pages: 2,
        total_count: 21
     }
  }
  ```
  
  + `prev_pave = -1` if current_page = 1
  + `next_pave = -1` if current_page = last_page

# Resources
* http://www.thegreatcodeadventure.com/making-a-rails-api-with-grap
* http://apionrails.icalialabs.com/book/chapter_one
* ...

rails5-grape-api-example

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README