API REST for beginners or why you should make your API understandable

Software Technologie Design

A brief introduction to REST and some context for newbies in this API world we are building

API REST for beginners...
...or why I should care about building an
understandable API

POST /hello-world
Javier Lafora
(@eLafo)

A small walk through historyA small walk through history

http://cartodb.github.io/lisbon-2014/#/2/24.7/-7.0/0

http://www.mediabistro.com/alltwitter/api-billionaires-club_b11424

http://www.programmableweb.com/news/9000-apis-mobile-gets-serious/2013/04/30

http://apiux.com/2013/05/29/api-hierarchy-needs/

https://www.lordabbett.com/content/lordabbett/en/perspectives/equityperspectives/finding-growth-

http://www.zdnet.com/internet-of-things-8-9-trillion-market-in-2020-212-billion-connected-things-7000021516/

Dissecting an HTTP Request
● Method
● Path
● Header
● Body

Methods
GET: Requests a representation of the specified resource
POST: Requests that the server accept the entity enclosed in the request as a new
subordinate of the web resource identified by the URI
PUT: Requests that the enclosed entity be stored under the supplied URI
PATCH: Apply partial modifications to a resource
DELETE: Deletes the specified resource
HEAD: Asks for the response identical to the one that would correspond to a GET
request, but without the response body
OPTIONS: Returns the HTTP methods that the server supports for the specified URL

Dissecting an HTTP response
● Status
● Header
● Body

http://www.slideshare.net/supercoco9/what-is-rest-why-is-it-part-of-the-rails-way-railsconf-2014-jav

RPC
What to do?
In the body
With what?
In the body
POST /rpc HTTP/1.1
Host: www.upcdatabase.com
User-Agent: XMLRPC::Client (Ruby
1.8.4)
Content-Type: text/xml; charset=utf-8
Content-Length: 158
Connection: keep-alive
<?xml version="1.0" ?>
<methodCall>
<methodName>lookupUPC</methodNa
me>
...
</methodCall>

REST
What to do?
In the HTTP method
With what?
In the path
GET /hello.txt HTTP/1.1
Host: www.example.com

REST-RPC Hybrid
What to do?
In the path
With what?
In the path
GET services/rest?api_key=xxx&method=flickr.photos.search&tags=penguin
HTTP/1.1
Host: www.flickr.com

REST
(Representational
State Transfer)
Roy Fielding
(2000)
Architecture for
the web

Uniform and constrained interface
http://www.ibm.com/developerworks/websphere/techjournal/0903_peterson/0903_peterson.html

Addressability
/bands/iron_maiden
/bands/the_beatles
/releases/20140529
/releases/last

HATEOAS (Hypermedia as the
Engine of Application State)

https://invoicefu.com/es/developers/api_docs

https://developers.teowaki.com/api-overview

Weitere ähnliche Inhalte

Ähnlich wie API REST for beginners or why you should make your API understandable

Azure API Management que permite proteger, publicar e analisar as nossas APIs e microsserviços numa gateway de API’s escalável. O objetivo desta sessão é partilhar experiência sobre as capacidades do Azure API Management: como podemos começar a usar; como podemos modernizar as nossos web services, adicionar novos protocolos de segurança; como podemos criar um site de documentação e testes para os developers; como pode ser a base para os seus projetos híbridos de Integração; e explorar algumas das suas funcionalidades principais. E como sempre, não é esperado que todos tenham conhecimento aprofundado desta tecnologia, mas apesar disso espera-se que esta será uma sessão interativa por forma a tentar ajudar-vos a compreende-la melhor.

API Management: Rise of the Planet of the Apps (2016 09-26 - Porto.Data)

Sandro Pereira

An API is only as good as its docs, so here is the most comprehensive list of documentation solutions for web APIs to date. These tools convert your Swagger, API Blueprint, RAML, WSDL, or other API specifications into static documentation or interactive API explorers that accelerate developer onboarding. This list covers open source software, licensed software, and API references generated within API management solutions. All will help in generating customizable HTML and CSS to display API methods, parameters, values, requests, responses, code samples, and more.

Ultimate Guide to 30+ API Documentation Solutions

Bill Doerrfeld

Intro to the HTML5 Application Repository Service

Marius Obert

HTML Hypermedia APIs and Adaptive Web Design - reject.js

Gustaf Nilsson Kotte

Top 7 wrong common beliefs about Enterprise API implementation

OCTO Technology

Octo API-days 2015

Antoine CHANTALOU

These are the slides from the API Management Workshop, held at the Startupbootcamp Berlin on October 17. We covered benefits of APIs for an organisation (regardless of size, sector, stage or purpose) and gave examples of successful deployment of APIs. We then described the typical API lifecycle: plan/design > build/integrate > operate/manage > share/engage. We covered many best practices and tools for each stage and gave practical demos about how to secure and manage APIs.

API Management Workshop (at Startupbootcamp Berlin)

3scale

Cloud Connectivity Service

jhpark

As soon as we start working on an API, architecture issues arise. Many mistaken common beliefs turn out to be fiction in this area. A poorly designed API architecture will lead to misuse or – even worse – not be used at all by its intended clients: application developers. To facilitate and accelerate design and development of your APIs, we share our vision and beliefs with you in this Reference Card. They come from our direct experience on API projects.

RefCard API Architecture Strategy

OCTO Technology

web apiで遊び倒す

Keiichi Daiba

HTML5 & Web Platform

SwapSkills

Consume (UI5) Web Apps from the HTML5 Application Repository

Marius Obert

API, Integration, and SOA Convergence

Kasun Indrasiri

Web2.0 2012 - lesson 7 - technologies and mashups

Carlo Vaccari

Cloudy Open Source and DevOps

Matt O'Keefe

Power BI for Developers @ SQLSaturday #420 (Paris)

Rui Romano

Web2 Expo San Francisco

Jure Cuhalev

WSO2Con Asia 2014 - Building the API-Centric Enterprise

All Things API Presentation - Gordon Weakleim [HomeAway]

Cloud Elements

Web3 File Storage Options

Gene Leybzon

Ähnlich wie API REST for beginners or why you should make your API understandable (20)

API Management: Rise of the Planet of the Apps (2016 09-26 - Porto.Data)

Ultimate Guide to 30+ API Documentation Solutions

Intro to the HTML5 Application Repository Service

HTML Hypermedia APIs and Adaptive Web Design - reject.js

Top 7 wrong common beliefs about Enterprise API implementation

Octo API-days 2015

API Management Workshop (at Startupbootcamp Berlin)

Cloud Connectivity Service

RefCard API Architecture Strategy

web apiで遊び倒す

HTML5 & Web Platform

Consume (UI5) Web Apps from the HTML5 Application Repository

API, Integration, and SOA Convergence

Web2.0 2012 - lesson 7 - technologies and mashups

Cloudy Open Source and DevOps

Power BI for Developers @ SQLSaturday #420 (Paris)

Web2 Expo San Francisco

WSO2Con Asia 2014 - Building the API-Centric Enterprise

All Things API Presentation - Gordon Weakleim [HomeAway]

Web3 File Storage Options

Mehr von Javier Lafora Rey

An introduction to Vue.js

Modular development with redux

Understanding big data-drupalcamp

APIs para gente normal

¿Por qué ruby on rails?

Ruby object model: A matter of life and death

ROA - Resource Oriented Architecture

How to use git without rage

Mehr von Javier Lafora Rey (8)

An introduction to Vue.js

Modular development with redux

Understanding big data-drupalcamp

APIs para gente normal

¿Por qué ruby on rails?

Ruby object model: A matter of life and death

ROA - Resource Oriented Architecture

How to use git without rage

Kürzlich hochgeladen

Crypto Cloud Review - How To Earn Up To $500 Per DAY Of Bitcoin 100% On AutoP...

SelfMade bd

Artyushina_Guest lecture_YorkU CS May 2024.pptx

AnnaArtyushina1

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

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

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

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 new york Psychic Readings, Attraction spells,Bri...

Modeling languages are generally applied for developing systems and software – both internally, with domain-specific languages, and with standardized languages targeting a general purpose and a wide audience. Way too often these languages are weakly created and defined leading to poor quality: Language definitions tend to contain errors and inconsistencies; notations do not recognize the communication and problem-solving needs of humans; standardization organizations push exchange formats that do not fully work and offer certificates that do not measure mastery of the language. We describe common problems in language development and point them out with examples from known cases. To overcome these problems, we suggest several solutions to improve language development, including using modeling languages specifically designed to define modeling languages, continuous testing and prototyping, and keeping language users in the loop.

What Goes Wrong with Language Definitions and How to Improve the Situation

Juha-Pekka Tolvanen

Abortion Pills In Pretoria ](+27832195400*)[ 🏥 Women's Abortion Clinic In Pretoria ● Abortion Pills For Sale In Pretoria ● Pretoria 🏥🚑!! Abortion Clinic Near Me Cost, Price, Women's Clinic Near Me, Abortion Clinic Near, Abortion Doctors Near me, Abortion Services Near Me, Abortion Pills Over The Counter, Abortion Pill Doctors' Offices, Abortion Clinics, Abortion Places Near Me, Cheap Abortion Places Near Me, Medical Abortion & Surgical Abortion, approved cyctotec pills and womb cleaning pills too plus all the instructions needed This Discrete women’s Termination Clinic offers same day services that are safe and pain free, we use approved pills and we clean the womb so that no side effects are present. Our main goal is that of preventing unintended pregnancies and unwanted births every day to enable more women to have children by choice, not chance. We offer Terminations by Pill and The Morning After Pill.” Our Private VIP Abortion Service offers the ultimate in privacy, efficiency and discretion. we do safe and same day termination and we do also womb cleaning as well its done from 1 week up to 28 weeks. We do delivery of our services world wide SAFE ABORTION CLINICS/PILLS ON SALE WE DO DELIVERY OF PILLS ALSO Abortion clinic at very low costs, 100% Guaranteed and it’s safe, pain free and a same day service. It Is A 45 Minutes Procedure, we use tested abortion pills and we do womb cleaning as well. Alternatively the medical abortion pill and womb cleansing !!!

Abortion Pills In Pretoria ](+27832195400*)[ 🏥 Women's Abortion Clinic In Pre...

Medical / Health Care (+971588192166) Mifepristone and Misoprostol tablets 200mg

WSO2CON 2024 - Cloud Native Middleware: Domain-Driven Design, Cell-Based Arch...

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 Winnipeg 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. Attraction Spells

%+27788225528 love spells in Huntington Beach Psychic Readings, Attraction sp...

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

WSO2Con2024 - WSO2's IAM Vision: Identity-Led Digital Transformation

WSO2Con2024 - From Code To Cloud: Fast Track Your Cloud Native Journey with C...

WSO2CON 2024 - Does Open Source Still Matter?

Abortion Pill Prices Tembisa [(+27832195400*)] 🏥 Women's Abortion Clinic in Tembisa ● Abortion Pills For Sale in Tembisa ● Tembisa 🏥🚑!! Abortion Clinic Near Me Cost, Price, Women's Clinic Near Me, Abortion Clinic Near, Abortion Doctors Near me, Abortion Services Near Me, Abortion Pills Over The Counter, Abortion Pill Doctors' Offices, Abortion Clinics, Abortion Places Near Me, Cheap Abortion Places Near Me, Medical Abortion & Surgical Abortion, approved cyctotec pills and womb cleaning pills too plus all the instructions needed This Discrete women’s Termination Clinic offers same day services that are safe and pain free, we use approved pills and we clean the womb so that no side effects are present. Our main goal is that of preventing unintended pregnancies and unwanted births every day to enable more women to have children by choice, not chance. We offer Terminations by Pill and The Morning After Pill.” Our Private VIP Abortion Service offers the ultimate in privacy, efficiency and discretion. we do safe and same day termination and we do also womb cleaning as well its done from 1 week up to 28 weeks. We do delivery of our services world wide SAFE ABORTION CLINICS/PILLS ON SALE WE DO DELIVERY OF PILLS ALSO Abortion clinic at very low costs, 100% Guaranteed and it’s safe, pain free and a same day service. It Is A 45 Minutes Procedure, we use tested abortion pills and we do womb cleaning as well. Alternatively the medical abortion pill and womb cleansing !!!

Abortion Pill Prices Tembisa [(+27832195400*)] 🏥 Women's Abortion Clinic in T...

Medical / Health Care (+971588192166) Mifepristone and Misoprostol tablets 200mg

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

WSO2CON2024 - It's time to go Platformless

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