Skip to content

Commit f26c224

Browse files
committed
Added examples, projects, resources and users.
1 parent 10c4bc7 commit f26c224

File tree

5 files changed

+105
-5
lines changed

5 files changed

+105
-5
lines changed

examples/index.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
layout: page
3+
title: Examples
4+
tags: [examples]
5+
comments: false
6+
---
7+
8+
* [Grape API Mounted on Rack w/ Static Pages](https://github.com/dblock/grape-on-rack): A sample Grape app mounted on Rack along with [a blog post](http://code.dblock.org/grape-api-mounted-on-rack-w-static-pages)) explaining how to go about mounting a basic API for a Rack app that can also serve static pages.
9+
* [Grape API Mounted on Rack w/ Dummy API data](https://github.com/kunovsky/Grape_on_rack_sqlite3): A sample Grape app mounted on Rack using Sqlite3 and a custom ORM.
10+
* [Grape API Mounted on Rails](https://github.com/dblock/grape-on-rails): A sample Grape app mounted on Rails.
11+
* [Grape API Mounted behind Goliath](https://github.com/dblock/grape-on-goliath): A sample Grape app mounted behind the Goliath web server.
12+
* [Grape API Mounted on Padrino](https://github.com/dblock/grape-on-padrino): A sample Grape app mounted on the Padrino web framework.
13+
* [Grape on Goliath on Heroku with Postgres](https://github.com/djones/grape-goliath-example): An example app using Goliath and Grape running on Heroku with Postgres, using a non-blocking flavor of ActiveRecord and the non-blocking Postgres database adapter.
14+
* [Goliath + Grape + MongoDB, on Heroku](https://github.com/lgs/GGM): Experimenting with Goliath asyncronous ruby web server framework, Grape APIs, gitwatcher.com data on MongoLAB/MongoDB and Heroku PAAS.
15+
* [ConfAsk Source](https://github.com/mbleigh/conf_ask): Source for the example Grape application demonstrated in the Grapes of Rapid talk at RubyConf 2010.
16+
* [Example Rails implementation](http://martinciu.com/2011/01/mounting-grape-api-inside-rails-application.html): A blog post explaining how to go about building a basic API for a Rails app using 3.x or 2.3x.
17+
* [Another Example of Basic Rails implementation](http://www.ruby-on-rails-outsourcing.com/2011/07/22/build-a-basic-api-in-a-rails-3-application): A short but detailed blog post showing how to set up a simple Grape API in Rails 3
18+
* [A Sample Blogging API](https://github.com/bloudraak/grape-sample-blog-api): An API for an over-simplified blogging system that directly interacts with the database models.
19+
* [A Grape w/ Warden Sample](https://github.com/dblock/grape_warden): A Grape API mounted on Rack with very simple authentication using Warden.
20+
* [Grape on Rack w/ ActiveRecord](https://github.com/cutalion/grape-api-example): Grape API mounted on Rack, using ActiveRecord, Roar Representers, Swagger and FDoc.
21+
* [Grape API v1 inside API v2](https://github.com/dblock/grape-on-rack-v1-inside-v2): Evolve a Grape API v1 into API v2, explain in [this blog post](http://code.dblock.org/evolving-apis-using-grape-api-versioning).
22+
* [Grape with ROAR](https://github.com/CansaSCitySchuffle/grape-roar-example): Example of Grape using Roar with header versioning, API inheritance and Swagger.
23+
* [Grape with Paperclip](https://github.com/omarfouad/rails_api_with_ajax_upload): Example of a Grape API mounted on Rails, to upload files with Paperclip & pure AJAX. Details in [this blog post](http://omarfouad.com/blog/2013/08/18/file-upload-api-with-grape-and-rails).
24+
* [Grape ToDo API](https://github.com/mateuszkosmider/todo-grape-api): A ToDo application.
25+
* [Grape w/ Rack-OAuth2](https://github.com/balauru/grape-oauth2-sample): Rack app running a Grape API and secured via OAuth2 via rack-oauth2.
26+
* [Accept-Version Header example](https://github.com/williamn/notes): Grape app mounted on Rails with `:accept_version_header` versioning strategy.
27+
* [Rails-Grape-Entity](https://github.com/philcallister/rails-grape-entity): a TODO app with grape and grape-entity.
28+
* [Grape w/ Rack + MongoDB](https://github.com/thiagogsr/grape-bootstrap): a bootstrap app to help you to start a Grape application without Rails
29+
* [Gitlab](https://github.com/gitlabhq/gitlabhq): Real world example of working grape API.
30+
* [zup-api](https://github.com/LaFabbrica/zup-api): Large nicely structured grape app.
31+
* [evercam-api](https://github.com/evercam/evercam-api): Grape application that manages all communication between Evecam Media & Evercam Clients.
32+
33+
### Contribute
34+
35+
Please [contribute your sample app](https://github.com/ruby-grape/ruby-grape.github.io/blob/master/CONTRIBUTING.md) to [this page](https://github.com/ruby-grape/ruby-grape.github.io/blob/master/examples/index.md).

index.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,17 @@ comments: false
66
[Community Projects](/projects)
77
Grape ecosystem projects.
88

9+
[Resources](/resources)
10+
Useful resources.
11+
12+
[Examples](/examples)
13+
Working projects using Grape.
14+
15+
[Users](/users)
16+
Who uses Grape?
17+
918
[History and Team](/team)
10-
Who maintains Ruby Grape?
19+
Who maintains Grape?
1120

1221
[Want to help?](https://github.com/ruby-grape/ruby-grape.github.io/issues)
1322
A number of non-code, community-related work-items you can help with.

projects/index.md

Lines changed: 29 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,45 +15,70 @@ comments: false
1515
* [grape-entity](https://github.com/ruby-grape/grape-entity): An API focused facade that sits on top of an object model.
1616
* [grape-rabl](https://github.com/LTe/grape-rabl): Use Rabl templates.
1717
* [grape-active_model_serializers](https://github.com/jrhe/grape-active_model_serializers): User active_model_serializers.
18+
* [grape-msgpack](https://github.com/rosylilly/grape-msgpack): Message pack formatter.
1819

1920
### Caching
2021

22+
* [garner](https://github.com/artsy/garner): A RACK-based cache implementation that works with Grape.
2123
* [grape-cache_control](https://github.com/karlfreeman/grape-cache_control): Cache-Control and Expires helpers.
2224
* [grape-rails-cache](https://github.com/monterail/grape-rails-cache): HTTP and server side cache integration with Rails.
25+
* [grape-shaman_cache](https://github.com/wjp2013/grape-shaman_cache): HTTP and server side cache integration for a non-Rails application and Jbuilder.
26+
* [grape-cache](https://github.com/AlexYankee/grape-cache): Another Grape middleware-style caching gem.
2327

2428
### Data
2529

2630
* [grape-activerecord](https://github.com/jhollinger/grape-activerecord): A simple way to use ActiveRecord with your Grape apps.
31+
* [api-pagination](https://github.com/davidcelis/api-pagination): Pagination with [will_paginate](https://github.com/mislav/will_paginate) or [kaminari](https://github.com/amatsuda/kaminari).
32+
* [grape-kaminari](https://github.com/monterail/grape-kaminari): [Kaminari](https://github.com/amatsuda/kaminari) paginator integration.
2733

2834
### HTTP
2935

3036
* [grape-cors](https://github.com/adamluzsi/grape-cors): Ruby Grape Api extension with Cross-origin resource sharing.
37+
* [grape-throttle](https://github.com/xevix/grape-throttle): Provides a simple endpoint-specific throttling mechanism.
38+
39+
### Routing
40+
41+
* [grape-route-helpers](https://github.com/reprah/grape-route-helpers): Path helpers for Grape APIs, similar to Rails' named path helpers.
3142

3243
### Logging
3344

34-
* [grape_logging](https://github.com/aserafin/grape_logging): Request logging for Grape.
45+
* [grape_logging](https://github.com/aserafin/grape_logging): Provides simple request logging capabilities (response code, path, parameters, request time, etc).
46+
* [grape-papertrail](https://github.com/sardaukar/grape-papertrail): [PaperTrail](https://github.com/airblade/paper_trail) integration for Grape.
47+
* [grape-present_cache](https://github.com/u2/grape-present_cache): Grape fragment cache.
3548

3649
### Authentication and Authorization
3750

3851
* [grape-doorkeeper](https://github.com/fuCtor/grape-doorkeeper): Grape integration with Doorkeeper.
52+
* [grape_api_signature](https://github.com/faber-lotto/grape_api_signature): A RACK-Based AWS Style signature authentication for grape API.
53+
* [wine_bouncer](https://github.com/antek-drzewiecki/wine_bouncer): Doorkeeper OAuth2 authorization middleware for grape APIs.
3954

4055
### Documentation
4156

42-
* [grape-swagger](https://github.com/tim-vandecasteele/grape-swagger): Add Swagger compliant documentation to your API.
57+
* [grape-swagger](https://github.com/tim-vandecasteele/grape-swagger): Provides an autogenerated documentation for your Grape API.
4358
* [grape-swagger-ui](https://github.com/kendrikat/grape-swagger-ui): Integrates swagger-ui with the Rails asset pipeline.
44-
* [grape-swagger-rails](https://github.com/TinkerDev/grape-swagger-rails): Integration with Swagger in Rails.
59+
* [grape-swagger-rails](https://github.com/TinkerDev/grape-swagger-rails): Swagger UI as Rails Engine for grape-swagger gem.
4560
* [grape-slate](https://github.com/connexio-labs/grape-slate): Allows for generating a Slate style for your API.
4661

47-
### Monitoring & Instrumentation
62+
### Monitoring, Performance & Instrumentation
4863

4964
* [newrelic-grape](https://github.com/xinminlabs/newrelic-grape): NewRelic instrumentation.
5065
* [grape-librato](https://github.com/seanmoon/grape-librato): Librato metrics.
5166
* [grape-appsignal](https://github.com/aai/grape-appsignal): Integration with AppSignal.
67+
* [grape-oink](https://github.com/xevix/grape-oink): Identify routes which significantly increase VM heap size using [oink parser](https://github.com/noahd1/oink).
68+
69+
### Development
70+
71+
* [grape-reload](https://github.com/AlexYankee/grape-reload): Expiremental approach for providing reloading of Grape-based rack applications in dev.
5272

5373
### Testing
5474

5575
* [grape-entity-matchers](https://github.com/agileanimal/grape-entity-matchers): Shoulda-style matchers to help with testing Grape entities.
5676

77+
### Generators
78+
79+
* [grape-scaffold](https://github.com/icicletech/grape-scaffold): An API scaffold generator for Rails.
80+
* [grape-api-generator](https://github.com/vinh0604/grape-api-generator): Some rails generators to help quickly bootstrap new Grape API structure.
81+
5782
### Opinionated Frameworks
5883

5984
* [grape_ape_rails](https://github.com/mepatterson/grape_ape_rails): Wrap the various best practices of integrating your API within the context of a Rails app.

resources/index.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
layout: page
3+
title: Resources
4+
tags: [resources]
5+
comments: false
6+
---
7+
8+
* [Google Group](https://groups.google.com/group/ruby-grape): Get Grape help here.
9+
* [Anatomy of a Ruby Gem: Grape](https://vimeo.com/98830727): A screencast digging through the internals of Grape.
10+
* [The Grapes of Rapid](http://confreaks.net/videos/475-rubyconf2010-the-grapes-of-rapid): RubyConf 2010 presentation about Grape and [slides](https://github.com/downloads/intridea/grape/The%20Grapes%20of%20Rapid.pdf).
11+
* [API Authentication w/ Devise](http://code.dblock.org/grape-api-authentication-w-devise): A tutorial on how to use Grape with Devise/Warden authentication.
12+
* [RESTful APIs with Grape](http://www.slideshare.net/dblockdotorg/building-restful-apis-w-grape): NYC.rb presentation about Grape in 2011.
13+
* [Grape and Rails Path Helpers](https://github.com/intridea/grape/wiki/Grape-and-Rails-Path-Helpers).
14+
* [From Zero to API Cache in 10 Minutes](http://www.confreaks.com/videos/986-goruco2012-from-zero-to-api-cache-w-grape-mongodb-in-10-minutes): a 10-minute talk at GoRuCo 2012 about API caching with Grape.
15+
* [OAuth2: Protect Grape API with Doorkeeper](http://blog.yorkxin.org/posts/2013/11/05/oauth2-tutorial-grape-api-doorkeeper-en): a tutorial for protecting a Grape API with OAuth 2 protocol using Doorkeeper and Ruby on Rails with a [working sample](https://github.com/chitsaou/oauth2-api-sample).
16+
* [Uploaded file and paperclip](https://github.com/intridea/grape/wiki/Uploaded-file-and-paperclip).
17+
* [Combine Swagger with Grape to Create an Interactive Documentation of Your API](http://bitboxer.de/2014/02/09/grape).

users/index.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
layout: page
3+
title: Users
4+
tags: [users]
5+
comments: false
6+
---
7+
8+
### Companies
9+
10+
* [Artsy.net](https://www.artsy.net) has a [public API](https://developers.artsy.net) built with Grape.
11+
12+
### Contribute
13+
14+
Please [contribute the name of your company](https://github.com/ruby-grape/ruby-grape.github.io/blob/master/CONTRIBUTING.md) to [this page](https://github.com/ruby-grape/ruby-grape.github.io/blob/master/users/index.md).

0 commit comments

Comments
 (0)