Building an API using Grape

•Download as PPTX, PDF•

0 likes•1,144 views

This document presents an overview of the Grape framework for building APIs in Ruby. It covers the basic usage of Grape, including versioning, formats, error handling, RESTful modeling, testing, documentation, and more. The goal of Grape is to provide a simple yet powerful framework for developing REST-style APIs in Ruby.

Software

Building an API using
Presented By
Visnupriya. J. R

©2014
Agenda
•What is Grape
•Basic Usage
•Versioning
•Format
•Error Handling
•Restful-Model-Presentation
•Testing
•Documentation

•Powerful API framework
•Designed to run on Rack Application
•To fit into Sinatra and Rails Application
•Grape framework mean "Generalized
Rapid API Erector"
©2014
What is Grape?

©2014
Basic Usage
module API
class Events < Grape::API
version 'v1‘
get :hello do
{ hello: "Spritle" }
end
end
end

©2014
Versioning
•Path
•Header
•Accept-Version Header
•Parameter

content_type :xml, ‘application/xml’
content_type :json, 'application/json‘
default_format :json ##Override default
format
format :json ## for single format
©2014
API Format
•Support XML, JSON, BINARY,
and TXT content-types
•Default format is :txt

$error! ‘Access Denied’, 401 ### return JSON format error!({error: “unexpected error”, detail: “missing widget”}, 500) ### rescue all exceptions and return in API format rescue_from :all ©2014 Error Handling$

©2014
Restful-Model-Presentation
•To represent data using
‘present’ method
–Grape Entities
–Hypermedia
–Rabl
–Active Model Serializers

•Can test API using RSpec
•RSpec supports API testing framework
with airborne gem
•https://github.com/brooklynDev/airbor
ne
©2014
Write Testing

•Easily can document API using Swagger
•What is Swagger?
•It’s provide web interface using
Swagger UI
•Run doc at
http://localhost:3000/apidoc
©2014
Documentation

©2014
More….
•Helper method
•Description
•Pagination with kaminari
•Cache
•Content Negotiation
•OAuth 1.0/2.0

References
•https://github.com/intridea/grape/wiki
•https://github.com/intridea/grape#wh
at-is-grape
•http://confreaks.com/videos/475-
rubyconf2010-the-grapes-of-rapid
•http://funonrails.com/2014/03/building-restful-
©2014
api-using-grape-in-rails/
•http://intridea.github.io/grape/docs/

©2014
WE
BUILD
APPS
THAT
PEOPLE
LOVE TO
USE
Cross-Platform Business Mobile
Apps Development
Enterprise Web Applications
Development
Social Media Integrated
Applications Development
Product Development Services

What's hot

Windows Containers - Microsoft Ignite The Tour

Eran Stiller

Jab14 exemple of integration of Joomla and slim Framework http://jandbeyond.org/program/sessions/dont-worry-be-api-best-practices-and-implementatio.html In the context of a website or web application, an application-programming interface or API allows software developers to interact with and build upon the data and/or services delivered by your website. Thus, APIs provide limitless flexibility, reach and innovative potential for any website, service or application. During the last few months, Pierre-André has performed extensive research and development to discover effective ways of adding an API to a Joomla website. In this interactive session, he will share his findings. Attendees can expect to learn, why you need an API for your web site, the pros and cons of various API solutions, and why a RESTful API is a good fit for Joomla. Best practices for implementing a well-documented, pragmatic, and RESTful API will be discussed, along with useful tools and sample code for using the com_api component as well as Slim Framework.

Don't worry be API with Slim framework and Joomla

Pierre-André Vullioud

Overview of RoR Setting up Environment Ruby Language MVC – ActiveRecord, ActionController, ActionView REST Architecture Routing DB Migrations ActiveRecord Associations Validation/Validation Helpers Forms/ActionView helpers Assets/Bundler Caching Debugging RoR Quick-start Demo

Ruby on Rails workshop for beginner

Umair Amjad

Building a scalable API with Grails

Tanausu Cerdeña

Picking gem ruby for penetration testers

Paolo Perego

Over the last few years, Airbnb’s frontend architecture has evolved to keep pace with the rapid advancement happening the JavaScript world. Starting as a humble Rails 2 + Prototype.js app in 2008, the frontend stack powering airbnb.com has gone through a few revisions, including a push towards single-page app architecture with Backbone.js and Handlebars.js, an adventure into isomorphic JavaScript with Rendr (our library for using Node.js to server-render Backbone SPAs), and most recently, a move toward React.js and a re-envisioning of our build pipeline to take advantage of CommonJS, ES6, and a Node.js-based transform system. Spike Brehm, software engineer on the @AirbnbNerds team, will walk through how we approached and executed on these changes. Plus, get excited to see a preview of our new approach to isomorphic JavaScript, allowing us to server-render React components from our Rails app. Spike Brehm is a software engineer at Airbnb who specializes in building rich web experiences. As a JavaScript nerd, he has spent the last few years shipping web apps and prototyping Airbnb’s front-end stack, experimenting with “isomorphic JavaScript” — apps that have the flexibility to run on both the client and sever using the same codebase.

The Evolution of Airbnb's Frontend

Spike Brehm

Asp.Net Core MVC , Razor page , Entity Framework Core

mohamed elshafey

Handling RESTful API requests with Laravel PHP Framework resource controllers is already very easy. With Laravel 5, handling request routing has been made even easier by using a configuration-as-annotation approach. Controller annotations may take advantage of doc block-style syntax and then be compiled using Laravel's artisan command-line tool. I'll present this approach by providing a few examples and discussing some of the pros and cons.

Laravel 5 Annotations: RESTful API routing

Christopher Pecoraro

Cocoa on-rails-3rd

Xiaochun Shen

AngularJS meets Rails

Elena Torró

Intro to Laravel

Azukisoft Pte Ltd

Rhodes

jwallace41

How angularjs saves rails

Michael He

IVS CTO Night And Day 2018 Winter - [re:Cap] Serverless & Mobile

Amazon Web Services Japan

Ruby w/o Rails (Олександр Сімонов)

Fwdays

Service Oriented Applications

Michael Bensoussan

Using RESTFUL APIs in ANGULARJS

Mindfire Solutions

Spring Boot Update

Sergi Almar i Graupera

Swagger UI

Walaa Hamdy Assy

Ruby On Rails

Eric Berry

What's hot (20)

Windows Containers - Microsoft Ignite The Tour

Don't worry be API with Slim framework and Joomla

Ruby on Rails workshop for beginner

Building a scalable API with Grails

Picking gem ruby for penetration testers

The Evolution of Airbnb's Frontend

Asp.Net Core MVC , Razor page , Entity Framework Core

Laravel 5 Annotations: RESTful API routing

Cocoa on-rails-3rd

AngularJS meets Rails

Intro to Laravel

Rhodes

How angularjs saves rails

IVS CTO Night And Day 2018 Winter - [re:Cap] Serverless & Mobile

Ruby w/o Rails (Олександр Сімонов)

Service Oriented Applications

Using RESTFUL APIs in ANGULARJS

Spring Boot Update

Swagger UI

Ruby On Rails

Similar to Building an API using Grape

This session will show you how you can easily document your REST API's using Spring & Swagger. It will show you how to use the Swagger-Spring integration in a Spring Boot application: Setup a basic REST API using Spring-Boot together with Swagger-Springfox Access and test the REST-API using the Swagger-UI client Generate client code stubs for your language (e.g. Java, PHP, Python, ...) using Swagger-Codegen Graphically display your REST-API using the Chrome plugin Swagger.ed Devoxx Belgium Nov. 2015

Document your rest api using swagger - Devoxx 2015

johannes_fiala

Getting Started with the WSO2 API Manager

WSO2

API Services: Building State-of-the-Art APIs

Apigee | Google Cloud

REST API 20.2 - Appworks Gateway Integration.pptx

Jason452803

A Journey from API Versioning to Canary Release | Nordic APIs Platform Summit...

Patrice Krakow

APIs provide broader opportunities for companies to connect with new partners with the use of APIs itself as an advertising media. A proper design of such RESTful APIs is key to achieving the above-mentioned goals and provides benefits of increasing API performance, reducing the API development effort, and minimizing the operational support burden. WSO2 API Manager helps companies venture into the API space with its own brand and control of an API management platform, providing a great deal of support for designing, implementing, and managing such APIs.

API designing with WSO2 API Manager

WSO2

A Journey from API Versioning to Canary Release | APIDays Zurich 2017

Patrice Krakow

Getting Started with the WSO2 manager

WSO2

Developing Apps with Azure AD

SharePointRadi

Apigility-powered API's on IBM i

chukShirley

InfluxDB 2.0 brings in support for many new client libraries. In this session, Noah will walk through how to use the new Java client library to access InfluxDB 2.0. InfluxDB comes with a new set of client libraries to allow you to insert time series data from your applications into the new InfluxDB 2.0. Specifically, Noah will share how to use the Java client library to insert data and query it in your applications.

2.0 Client Libraries & Using the Java Client by Noah Crowley, Developer Advoc...

InfluxData

Using the Java Client Library by Noah Crowley, DevRel | InfluxData

InfluxData

Integrate any Angular Project into WebSphere Portal

Himanshu Mendiratta

API Versioning for Zero Downtime | Devoxx Belgium 2017

Patrice Krakow

Angular2.0@Shanghai0319

Bibby Chung

Streamlined Geek Talk

Sarah Allen

Redesigning a public web service API is a major undertaking: 3 years, thousands of hours of work, new clients, new documentation, a series of releases... This is the story of the DNSimple API v2, a project that started with a single, innocuous GitHub pull request with the title "Proposal for versioned API" in December 2013, and which came to a successful general availability launch at the end of 2016. Simone will explain some of the decisions that the team took over the last 3 years that shaped the development of the API as well as challenges the team faced, and provide you with tips and techniques that may help you in your next major API project. Finally, the important question: what’s next?

LF_APIStrat17_The Great API Redesign

LF_APIStrat

Api clarity webinar

LibbySchulze

The motivation on why and when to use API-First service design. What are the real-life poblems in application development with regard to API's ? And how to solve these using tools like Swagger Editor , Swagger UI and Swagger-codegen. And how can an API Manager tool help to manage the Apllication Lifecycle of your API ( publishing , versioning, registration of consumers , quota's and rate-limiting )

Api-First service design

Stefaan Ponnet

RESTful web APIs (build, document, manage)

Cisco DevNet

Similar to Building an API using Grape (20)

Document your rest api using swagger - Devoxx 2015

Getting Started with the WSO2 API Manager

API Services: Building State-of-the-Art APIs

REST API 20.2 - Appworks Gateway Integration.pptx

A Journey from API Versioning to Canary Release | Nordic APIs Platform Summit...

API designing with WSO2 API Manager

A Journey from API Versioning to Canary Release | APIDays Zurich 2017

Getting Started with the WSO2 manager

Developing Apps with Azure AD

Apigility-powered API's on IBM i

2.0 Client Libraries & Using the Java Client by Noah Crowley, Developer Advoc...

Using the Java Client Library by Noah Crowley, DevRel | InfluxData

Integrate any Angular Project into WebSphere Portal

API Versioning for Zero Downtime | Devoxx Belgium 2017

Angular2.0@Shanghai0319

Streamlined Geek Talk

LF_APIStrat17_The Great API Redesign

Api clarity webinar

Api-First service design

RESTful web APIs (build, document, manage)

Recently uploaded

Technology has taken up space all over the world. From generating content with a single command on ChatGPT to getting your food served by Robots at your favorite restaurant, artificial advancements have ruled every space. Every industry is set to develop top-notch technology in every sector; finance, IT, healthcare, gaming, and banking, with competitive market standards. One of these rapidly growing industries is Mobile App Development. According to the Straits Research report, it is expected to reach USD 583.03 billion at a CAGR OF 12.8% between (2022 and 2030). It clearly shows how mobile app development has become an integral part of the digital landscape and revolutionized technology.

The Top App Development Trends Shaping the Industry in 2024-25 .pdf

ayushiqss

Direct Style Effect Systems -The Print[A] Example- A Comprehension Aid

Philip Schwarz

%in Lydenburg+277-882-255-28 abortion pills for sale in Lydenburg

masabamasaba

%in Bahrain+277-882-255-28 abortion pills for sale in Bahrain

masabamasaba

Foundation models are machine learning models which are easily capable of performing variable tasks on large and huge datasets. FMs have managed to get a lot of attention due to this feature of handling large datasets. It can do text generation, video editing to protein folding and robotics. In case we believe that FMs can help the hospitals and patients in any way, we need to perform some important evaluations, tests to test these assumptions. In this review, we take a walk through Fms and their evaluation regimes assumed clinical value. To clarify on this topic, we reviewed no less than 80 clinical FMs built from the EMR data. We added all the models trained on structured and unstructured data. We are referring to this combination of structured and unstructured EMR data or clinical data.

Reassessing the Bedrock of Clinical Function Models: An Examination of Large ...

harshavardhanraghave

Craft an AI & Machine Learning Pitch with our Editable Professional PowerPoint Template. Ignite your AI & Machine Learning pitch with our cutting-edge PowerPoint template tailored for the industry. Perfect for AI conferences, investor presentations, sales pitches to tech-focused companies, training sessions, and educational programs. - 20+ editable slides: Get a variety of options to choose from for your presentation. - Time-saving solution: Download, replace text/images with a few clicks. - User-friendly customization: Easy to use and personalize. - Modern and attractive design: Captivating visuals, sleek layout. - Tailored to your requirements: Fully alterable for customization. - Well-organized slides: Complete control over content. - Thematic specificity: Reflects healthcare industry with relevant graphics. - Showcase your business idea: Communicate value proposition effectively.

AI & Machine Learning Presentation Template

Presentation.STUDIO

Data spaces in distributed environments should be allowed to evolve in agile ways providing data space owners with large flexibility about which data they store. Agility and heterogeneity, however, jeopardize data exchanges because representations may build on varying ontologies and data consumers may not rely on the semantic correctness of their queries in the context of semantically heterogeneous, evolving data spaces. Graph data spaces are one example of a powerful model for representing and querying data whose semantics may change over time. To assert and enforce conditions on individual graph data spaces, shape languages (e.g SHACL) have been developed. We investigate the question of how querying and programming can be guarded by reasoning over SHACL constraints in a distributed setting and we sketch a picture of how a future landscape based on semantically heterogeneous data spaces might look like.

Shapes for Sharing between Graph Data Spaces - and Epistemic Querying of RDF-...

Steffen Staab

We specialize in Psychic Readings, Psychic Love Spells, Binding Love Spells, Obsession Spells, Voodoo Spells, Lottery Spells, Marriage Spells, Black Magic Spells, Palm Readings & much more. Are you depressed? We perform this come-to-me love spell that works instantly with the aim of bringing back the victim to the person performing the magic. Have you lost your lover? We perform this come-to-me love spell that works instantly with the aim of bringing back the victim to the person performing the magic. Have you lost your lover? Do u need to solve any relationship problem? Contact the powerful spells caster chief kule with love spells that work overnight and love spells that really work. Have you found yourself infatuated with a special someone you think could be the one? Are you looking for a spell to provide them with a nudge in the right direction? Or maybe the spell you cast didn’t achieve the results you were hoping for? Whether you’re new or versed in the ways of spell casting, we’re here to help. Today we’re going to provide you with a detailed guide on the types of love spells to cast. Not only that but there’s something for those who wish to find outside advice from more advanced spell casters. We’re also going to provide you with the top sites available to help you with your dilemma. Let’s begin our journey by educating ourselves on love magic and what a real love caster looks like. Love Magic and Love Casters Love magic made its first appearance back in Ancient Egypt and has been an active practice since. This type of magic is a branch of traditional magic and can be practiced in various ways. Typically the more common use of love magic is through the work of spells, but other methods look like Charms Rituals-LOVE Potions-Dolls and even Amulets If you are interested in becoming a love caster, be prepared for what’s to come. A genuine love caster knows that the art of love casting is no easy feat and shouldn’t be done casually. You should know that not only does it require you to be gifted spiritually, but you must be ready to serve others. Someone who is considered a real love caster has experience in all manner of spells, no matter the difficulty. Training yourself in attraction, commitment, and marriage spells is an excellent place to start. But this by no means will make you a professional. Practice your craft and expand your knowledge; understand that you will possess the ability to help others in time truly. Types of Love Spells What better way to start broadening your experiences with love spells than by learning more about them? These spells work like just about any other spell. Simply apply your intention, use a medium (sigils, mantras, candles, or charm bags), and top it off with establishing the belief that you will receive what you want. So what kind of spells are available and which ones suit your needs the best? Let’s take a look at the many options you have at your disposal.

%+27788225528 love spells in Atlanta Psychic Readings, Attraction spells,Brin...

masabamasaba

Generic or specific? Making sensible software design decisions

Bert Jan Schrijver

%in Durban+277-882-255-28 abortion pills for sale in Durban

masabamasaba

OpenChain - The Ramifications of ISO/IEC 5230 and ISO/IEC 18974 for Legal Pro...

Shane Coughlan

%in ivory park+277-882-255-28 abortion pills for sale in ivory park

masabamasaba

%+27788225528 love spells in Boston Psychic Readings, Attraction spells,Bring...

masabamasaba

Investing in AI transformation today The modern business advantage: Uncovering deep insights with AI Organizations around the world have come to recognize AI as the transformative technology that enables them to gain real business advantage. AI’s ability to organize vast quantities of data allows those who implement it to uncover deep business insights, augment human expertise, drive operational efficiency, transform their products, and better serve their customers

Microsoft AI Transformation Partner Playbook.pdf

Willy Marroquin (WillyDevNET)

%in Midrand+277-882-255-28 abortion pills for sale in midrand

masabamasaba

%in Stilfontein+277-882-255-28 abortion pills for sale in Stilfontein

masabamasaba

Looking for an efficient way to manage your finances? Look no further than our money management app. With easy-to-use features, you can track your expenses, create budgets, and monitor your savings goals all in one place. Our app provides real-time updates on your spending habits and helps you make smarter financial decisions. Take control of your finances today with our user-friendly money management app.

Right Money Management App For Your Financial Goals

Jhone kinadey

8257 interfacing 2 in microprocessor for btech students

HimanshiGarg82

(Vivek)Call Us, 8448380779,Call girls in Delhi NCr – We Offer best in class call girls. escort Service At Affordable Price At low Rate with Space Night 8000 We Are One Of The Oldest Escort and Call girls Agencies in Delhi. You Will Find That Our Female Escorts Are Full Of Fun, Sexy And They Would Love Enjoy Your Company. We Have A Fantastic Selection Of Escort Ladies Available For In-Calls As Well As Out-Calls. Our Escorts Are Not Only Beautiful But All Have Great Personalities Making Them The Perfect Companion For Any Occasion. In-Call:- You Can Come At Our Place in Delhi Our place Which Is Very Clean Hygienic 100% safe Accommodation. Out-Call:- You have To Come Pick The Girl From My Place We Are Also Provide Door Step Services (Delhi Ncr, Noida, Gurgaon, Faridabad, Ghaziabad Note:- Pic Collectors Time Passers Bargainers Stay Away As We Respect The Value For Your Money Time And Expect The Same From You Hygienic:- Full Ac room And Clean Rooms Available In Hotel 24 * 7 Hourly In Delhi NCR More Details, With WhatsApp Number, +91-8448380779

call girls in Vaishali (Ghaziabad) 🔝 >༒8448380779 🔝 genuine Escort Service 🔝✔️✔️

Delhi Call girls

introduction-to-automotive Andoid os-csimmonds-ndctechtown-2021.pdf

VishalKumarJha10

Recently uploaded (20)

The Top App Development Trends Shaping the Industry in 2024-25 .pdf

Direct Style Effect Systems -The Print[A] Example- A Comprehension Aid

%in Lydenburg+277-882-255-28 abortion pills for sale in Lydenburg

%in Bahrain+277-882-255-28 abortion pills for sale in Bahrain

Reassessing the Bedrock of Clinical Function Models: An Examination of Large ...

AI & Machine Learning Presentation Template

Shapes for Sharing between Graph Data Spaces - and Epistemic Querying of RDF-...

%+27788225528 love spells in Atlanta Psychic Readings, Attraction spells,Brin...

Generic or specific? Making sensible software design decisions

%in Durban+277-882-255-28 abortion pills for sale in Durban

OpenChain - The Ramifications of ISO/IEC 5230 and ISO/IEC 18974 for Legal Pro...

%in ivory park+277-882-255-28 abortion pills for sale in ivory park

%+27788225528 love spells in Boston Psychic Readings, Attraction spells,Bring...

Microsoft AI Transformation Partner Playbook.pdf

%in Midrand+277-882-255-28 abortion pills for sale in midrand

%in Stilfontein+277-882-255-28 abortion pills for sale in Stilfontein

Right Money Management App For Your Financial Goals

8257 interfacing 2 in microprocessor for btech students

call girls in Vaishali (Ghaziabad) 🔝 >༒8448380779 🔝 genuine Escort Service 🔝✔️✔️

introduction-to-automotive Andoid os-csimmonds-ndctechtown-2021.pdf

Building an API using Grape

1. Building an API using Presented By Visnupriya. J. R

6. content_type :xml, ‘application/xml’ content_type :json, 'application/json‘ default_format :json ##Override default format format :json ## for single format ©2014 API Format •Support XML, JSON, BINARY, and TXT content-types •Default format is :txt

7. error! ‘Access Denied’, 401 ### return JSON format error!({error: “unexpected error”, detail: “missing widget”}, 500) ### rescue all exceptions and return in API format rescue_from :all ©2014 Error Handling

12. References •https://github.com/intridea/grape/wiki •https://github.com/intridea/grape#wh at-is-grape •http://confreaks.com/videos/475- rubyconf2010-the-grapes-of-rapid •http://funonrails.com/2014/03/building-restful- ©2014 api-using-grape-in-rails/ •http://intridea.github.io/grape/docs/

14. ©2014 WE BUILD APPS THAT PEOPLE LOVE TO USE Cross-Platform Business Mobile Apps Development Enterprise Web Applications Development Social Media Integrated Applications Development Product Development Services

Building an API using Grape

Recommended

Recommended

More Related Content

What's hot

What's hot (20)

Similar to Building an API using Grape

Similar to Building an API using Grape (20)

Recently uploaded

Recently uploaded (20)

Building an API using Grape