REST APIとは何か？をわかりやすく説明するために論文を読んでみた
Posted: 2019-01-15
スポンサーリンク
目次
はじめに
前回の記事: APIとは何か？をできる限りわかりやすく説明したいではAPIそのものの説明をしました。
今回はAPIの形式の一つである REST API について説明したいと思います。
なお、今回の記事も初心者エンジニアが対象です。(少し技術的な用語を使って説明します)
読み方
まずはじめに読み方から。 RESTと書いて レスト と読みます。 REpresentational State Transfer の略だそうです。
RESTとは
システムの設計原則(設計の考え方)の一つです。元々はAPIに限らずウェブ全体に適用するための考え方です。
このRESTの考え方に従って設計されたAPIを REST API と言います。
ちなみにこのRESTという考え方は Roy Fielding という方が2000年に発表した論文で初めて提唱されたものだそうです。
論文の原文は こちら ですので、興味がある方は見て頂ければと。
REST と RESTful の違いは
RESTについて調べると、必ず RESTful という言葉も出てくるかと思います。
これは一言でいうと RESTなAPI、つまり REST原則に則って作られたAPI という意味だそうで、実際の現場ではRESTとRESTfulは同じ意味で使われているように思います。
RESTの定義とは
それでは、RESTとはどういう定義なのかを説明していきます。
厳密なRESTの定義
まずは論文で提唱されている定義です。論文にはRESTを実現するためには以下7点の制約を満たす必要があると書かれています。
論文はこちら(英語です)
- クライアント・サーバの構成であること
- ステートレスであること
- キャッシュを備えていること
- 統一的なインターフェイスであること
- 階層化されたシステムで構成されていること
- コードオンデマンド(プログラムをクライアント側で実行する方式。javascriptなど)であること
いかがでしょうか。
私は正直に言ってこれを見てもどんなものなのかさっぱりイメージできません。。
上記は厳密かつ古い(約20年前の)定義であり、現状のウェブシステムでは当たり前のようなことまで書かれており、REST APIを理解するための説明としては少しわかりづらくなっているかもしれません。
(クライアント・サーバであることやキャッシュなど)
一般的なRESTの特徴(主観)
ということで、理解を助けるためにより現実的なREST APIの特徴を説明したいと思います。
※大きくズレてはないと思いますが、私の主観的な内容ですのでご留意を。
REST APIの特徴
- URI(HTTPのパス)が名詞形であること(動詞を含まないこと)
- リソース(操作対象のもの)の操作(作成/閲覧/変更/削除)をHTTPのメソッドにより指定できること
- レスポンス形式がjsonもしくはXMLであること
先程の厳密な定義よりは具体的になったでしょうか。
しかしこの説明だけでは、まだぼんやりしているかもしれません。具体例を交えて説明します。
REST APIの例
今回は、ユーザーを管理するAPIを例に上げたいと思います。
| やりたいこと | URL | HTTPのメソッド |
|---|---|---|
| ユーザ一覧確認 | https://APIサーバのホスト名/users |
GET |
| ユーザ新規登録 | https://APIサーバのホスト名/users |
POST |
| ユーザ変更 | https://APIサーバのホスト名/users/ユーザID |
PUT |
| ユーザ削除 | https://APIサーバのホスト名/users/ユーザID |
DELETE |
詳細を説明する前に、比較のため RESTではないAPIの例も出してみます。
RESTではないAPIの例
| やりたいこと | URL | HTTPのメソッド |
|---|---|---|
| ユーザ一覧確認 | https://APIサーバのホスト名/get_users |
GET |
| ユーザ新規登録 | https://APIサーバのホスト名/create_user |
GET |
| ユーザ変更 | https://APIサーバのホスト名/modify_users |
GET |
| ユーザ削除 | https://APIサーバのホスト名/delete_users |
GET |
いかがでしょうか。違いがわかりましたでしょうか。
改めてREST APIの特徴
具体例を見たところで、改めて特徴について解説していきます。
URI(HTTPのパス)が名詞形であること(動詞を含まないこと)
これは、先程の例で言えばREST APIの場合、URIは /users、 非RESTの場合は /get_users のようになっていました。
このように URIが名詞形だけであること がREST APIの特徴です。
一方、疑問が浮かんだ方もいらっしゃるかと思います。
「一つのURIしかないのに、どうやって作ったり消したりするの？RESTじゃないほうは get とか delete って書いてあってわかりやすいのに。。」
といった疑問です。その答えは次の特徴にあります。
リソースの操作をHTTPのメソッドにより指定できること
先程の疑問には HTTPのメソッドを変えることで作る、消すなどの操作を変える というのが回答となります。
つまり、同じURLにアクセスした場合でも、HTTPのメソッドが違うと異なる動作をするということです。
(ちなみにHTTPのメソッドというのは、HTTPのリクエストに含めることができる情報の一つです。)
具体的に言うと、
GETメソッドでアクセスする -> ユーザ一覧を返す
POSTメソッドでアクセスする -> ユーザを新規作成する
のように動作します。具体例としてcurlコマンドで言うと、
# ユーザ一覧取得
curl -X GET https://サーバのAPI/users
# ユーザ新規作成
curl -X POST https://サーバのAPI/users
のようになります。
ちなみに各メソッドと動作の関係ですが、一般的には先程説明したように
| メソッド | 動作 | (参考)SQLでの動作名 |
|---|---|---|
| GET | リソース情報の取得 | select |
| POST | リソース新規作成 | insert |
| PUT/PATCH | リソース更新 | update |
| DELETE | リソース削除 | delete |
のようにメソッド割り当てられています。
レスポンス形式がjsonもしくはXMLであること
これは書いてあるまんまなのですが、サーバからのレスポンスがjsonかXML形式で返ってくることです。
ちなみに私の経験では、最近のウェブAPIはほとんどjsonになっていると思います。(XMLはあまり見ない)
まとめ
以上、REST APIとは をできる限りわかりやすく説明してみました。
この記事を書くにあたりいろいろ調べてみてはいますが、誤り等がございましたらコメント頂ければと思います。
参考文献
https://www.ics.uci.edu/~fielding/pubs/dissertation/rest_arch_style.htm
http://restcookbook.com/Basics/codeondemand/
http://blog.sojiro.me/blog/2014/09/14/what-is-rest/
スポンサーリンク
コメント一覧
2022/09/18 07:32:38
Reombakさん
A surgical skin biopsy was taken from the patient s left calf for histopathologic examination. doxycycline for dog Drink plenty of liquids while you are taking Doxycycline with Cleanser.
2022/09/18 09:45:03
EachelleOaOaさん
free singles dating
100% free dating site in europe
single dating
2022/09/18 17:33:11
AlvinJowさん
Many thanks. I enjoy this.
national honor society essay help essay writer help with handwriting
2022/09/18 23:02:25
AlvinJowさん
Seriously lots of superb facts!
how to write an essay for graduate school essays writer cheap custom essay writing service
2022/09/19 00:12:48
AlvinJowさん
Point well regarded!!
college student essay https://freshapps.space/ writing service online
2022/09/19 02:10:59
Wendellunapsさん
Thank you. I value this!
top rated online canadian pharmacies best online pharmacies no prescription web medical information
2022/09/19 06:00:04
BruceCandyさん
Point well taken!!
canada online pharmacy pharmacy price comparison meds online
2022/09/19 09:42:55
JoeteOaOaさん
dating site sign up
free single dating online
date free website
2022/09/19 12:03:26
AlvinJowさん
Nicely put, Appreciate it!
things to write a persuasive essay on writing an essay intro online resume writing services
2022/09/19 19:49:15
BruceCandyさん
You said it perfectly.!
national pharmacies canada pharmacy online pharmacy online mexico
2022/09/19 21:16:39
Michaelpedさん
You mentioned this wonderfully!
north west pharmacy canada prescription cost pharmacy without dr prescriptions https://canadianpharmacyonlinedb.com
2022/09/20 04:26:04
MarrisOaOaさん
editing essay services
best college essay writing service
essay writing service review
2022/09/20 19:30:29
Wendellunapsさん
Really loads of good material.
national pharmacies canadian pharmacy generic viagra canadian online pharmacies legitimate by aarp
2022/09/20 23:45:56
DorolisaOaOaさん
essay writer website
essay writer service review
legitimate essay writing service
2022/09/21 00:41:25
Michaelpedさん
Superb stuff, Thank you.
shoppers pharmacy canadian drugstore online canada pharmaceuticals online https://canadianpharmacies-24h.com
2022/09/21 02:56:38
AlvinJowさん
Superb postings. Cheers!
introduction essay writing essay writer blog writing service
2022/09/21 04:11:58
AlvinJowさん
Useful information. Appreciate it!
writing an evaluation essay the best essay writer academic writers online
2022/09/21 10:37:19
AlvinJowさん
Valuable content. Kudos.
how to write a critical evaluation essay scholarship essays for college dissertation ghostwriter
2022/09/21 13:08:26
BruceCandyさん
Many thanks, Ample content!
canadian pharmacies without prescriptions prescription without a doctor's prescription online pharmacies canada
2022/09/21 17:09:26
AlvinJowさん
Very well voiced truly! .
custom essay writing service org how to write scholarship essays ebook writing service
2022/09/21 22:01:48
MartyOaOaさん
paid essay writers
top 10 essay writing services
help writing essays
2022/09/21 23:43:39
AlvinJowさん
Excellent info. Kudos.
steps to writing a narrative essay https://homeworkcourseworkhelps.com/ technical writer
2022/09/22 06:16:11
AlvinJowさん
You actually said this perfectly!
write and essay https://essaywriting4you.com/ dissertation writers
2022/09/22 17:46:14
MerolaOaOaさん
research essay help
custom essay writing toronto
write my essay students
2022/09/23 01:40:21
AlvinJowさん
You mentioned that fantastically!
writing quotes in an essay how to write a short story essay assignment writing help
2022/09/23 13:37:34
AshlenOaOaさん
law school essay editing service
buy essays online cheap
please help me write my essay
2022/09/23 14:40:02
AlvinJowさん
Perfectly expressed without a doubt! .
college essay checklist pay for essay cheap essay on website
2022/09/24 06:14:14
Wendellunapsさん
You made your point extremely nicely!!
ed meds online without doctor prescription drug price mexican pharmacies shipping to usa
2022/09/24 10:57:21
Michaelpedさん
Very good material, Many thanks!
canada pharma limited canadadrugsonline online pharmacy school https://canadianonlinepharmacybase.com
2022/09/25 03:17:08
CharitaOaOaさん
best essay writer
will someone write my essay for me
essay help college
2022/09/25 09:59:49
AlvinJowさん
Effectively expressed certainly. .
best college admissions essays how to write an argumentative essay custom writings service
2022/09/25 11:14:22
AlvinJowさん
Seriously a good deal of helpful knowledge.
essay assignment help https://essaywriting4you.com/ article rewriting services
2022/09/25 13:38:37
BruceCandyさん
Valuable advice. With thanks!
overseas pharmacy forum prescription cost comparison canadian pharmacies-247
2022/09/25 22:29:19
NaniceOaOaさん
romeo and juliet essay help
help to write essay
law school essay editing service
2022/09/26 17:46:40
ChelsaeOaOaさん
best essay writing service review
personal essay writers
essay help forum
2022/09/27 13:07:06
PennyOaOaさん
medical school essay service
college essay writing service
best writing paper
2022/09/28 09:02:21
TammieOaOaさん
law school essay review service
buy essay cheap online
custom essay paper writing
2022/09/29 05:00:22
AntonieOaOaさん
best online essay writer
write my essay canada
best essay editing service
2022/09/30 00:40:11
RhiamonOaOaさん
do my essay for me cheap
custom writing essay
quality custom essays
2022/10/01 13:55:28
DronaOaOaさん
buy pre written essays
help write an essay
professional custom essays
2022/10/02 09:39:46
TwylaOaOaさん
write my admission essay
buy essays for college
help with writing an essay
2022/07/08 00:49:15
AurlieOaOaさん
jackpot magic slots blog
slots game
hc slots
2022/07/20 15:48:41
ChandaOaOaさん
dissertation writing service
dissertation proposal help
average dissertation length
2022/07/21 10:04:08
AvivaOaOaさん
proposal writing company
dissertation help free
help with dissertation
2022/07/22 05:35:44
DortheaOaOaさん
proquest dissertations
get help with dissertation
what is dissertation
2022/07/23 18:13:15
GlynnisOaOaさん
writing paper help
dissertation express
what is dissertation
2022/07/24 12:38:52
SuzannOaOaさん
dissertation service
writing a dissertation methodology
writing
2022/07/25 07:19:46
SalliOaOaさん
dissertation help service general
best rated essay writing service
example of dissertation
2022/07/26 04:33:51
DarsieOaOaさん
how long is a doctoral dissertation
doctoral dissertation help qualitative
rutgers dissertation proposal help
2022/07/26 10:15:06
TandiOaOaさん
free cash bonus no deposit casino
the best online casino
online gambling reviews
2022/07/26 19:15:24
Jariewereさん
cialis generic reviews Cheapest Metformin
2022/07/27 02:48:20
MabelleOaOaさん
defending your dissertation
uf dissertation format
help writing a dissertation
2022/07/27 11:36:53
TandiOaOaさん
mobile online casino
bingo online for money
no deposit welcome bonus casino
2022/07/27 23:56:34
JenneeOaOaさん
masters dissertation writing services
best dissertation writing service uk
dissertation research and writing
2022/07/28 11:36:39
AbagaelOaOaさん
usa casino
mobile casino games for real money
casino signup bonus
2022/07/28 20:04:04
HerminaOaOaさん
buy art online berlin
buy dissertation online
powerpoint for creative writing
2022/07/29 10:41:24
ShaylaOaOaさん
real casino online
real money casinos
casino online usa
2022/07/29 15:52:23
AudreOaOaさん
proposal and dissertation help 3000 words
dissertation online help
dissertation database
2022/07/30 11:27:59
HestiaOaOaさん
doctoral dissertation help qualitative
dissertation help methodology
dissertation acknowledgement sample
2022/07/30 09:23:10
VerenaOaOaさん
slotos
free casino money
sign up bonus no deposit
2022/07/31 07:17:15
DixieOaOaさん
us online casino
no deposit casino
mobile casino real money
2022/08/01 05:29:03
LaureenOaOaさん
online casino no deposit bonus 2021
free online games to win real money no deposit
best online casino to win money
2022/08/02 06:19:07
FranniOaOaさん
free sign up bonus
no deposit sign up bonus casino
best online casino deposit bonuses
2022/08/03 04:37:52
PearlOaOaさん
free online games to win real money no deposit
casino bonuser
free welcome bonus no deposit casino
2022/08/04 03:15:11
BobbieOaOaさん
free no deposit
online casino real money usa
no deposit bonus
2022/08/05 01:17:29
LeslieOaOaさん
free bonus casino
real casino online
online american casinos
2022/08/08 01:49:08
TrudieOaOaさん
us casino
online casinos no deposit
no deposit free bonus casino
2022/08/08 04:59:53
HonorOaOaさん
best vpn services 2016
free vpn unlimited
best vpn for netflix
2022/08/09 01:47:39
TeddieOaOaさん
business vpn
free chrome vpn
private internet access vpn
2022/08/09 01:59:04
JaynellOaOaさん
online casino usa real money no deposit bonus
best no deposit bonus online casino
win real money online casino
2022/08/10 09:37:02
DulceaOaOaさん
real casino online
cash casino games
best online casino bonus
2022/08/10 10:03:41
JenneeOaOaさん
buy avast vpn
firestick vpn free
free vpn client
2022/08/11 08:50:48
CarolanOaOaさん
american online casinos
sign up bonus casino no deposit
casino free bonus
2022/08/11 06:05:25
JenneeOaOaさん
which free vpn is best?
best vpn for gaming
best vpn 2017
2022/08/12 02:55:55
AshleighOaOaさん
unlimited free vpn
best vpn for chrome free
one time buy vpn
2022/08/12 08:44:31
FanyaOaOaさん
online casino reviews usa
best usa online casino
casinos online real money
2022/08/13 01:02:22
KelseyOaOaさん
free vpn trial
tor free vpn
super vpn
2022/08/13 19:33:01
LaurellaOaOaさん
vpn for netflix free
hide me vpn free
vpn free reddit
2022/08/15 00:22:12
Piniwhipsさん
ivermectin tractor supply comprar cialis plata
2022/08/15 23:37:23
FifineOaOaさん
top online casinos
online casino usa real money no deposit bonus
free casino bonus
2022/08/15 23:54:44
SheelaghOaOaさん
free vpn app
buy vpn with gift card
best vpn for home network
2022/08/16 21:54:26
GwenoreOaOaさん
no deposit casino real money
best mobile casinos
casino no deposit welcome bonus
2022/08/20 05:44:59
encathyさん
Cialis Kaufen Spanien stromectol ivermectin buy Ketoconazole
2022/08/24 03:41:26
GladiOaOaさん
latino gay dating site's
squirt gay hook up dating cruising and sex site
gay dating free
2022/08/25 18:52:46
KyrstinOaOaさん
what are the names of gay dating sites
free gay dating older men
hispanic gay dating sites
2022/08/26 13:11:43
BertheOaOaさん
dating sites free near me
local-singles club
christian dating for free
2022/08/27 10:23:38
KaitlynnOaOaさん
singles chat
free datinsites chat
freeadultdating
2022/08/28 08:24:38
DavinaOaOaさん
singles website for farmers
dating dating site
dating apps free
2022/08/28 11:17:52
GladiOaOaさん
gay dating, caffmos
black gay men dating sites
squirt gay dating cruising and sex site
2022/08/29 06:30:12
ChelsaeOaOaさん
plenty of fish dating site
zoosk dating
tinder dating site
2022/08/29 06:27:43
JeraleeOaOaさん
gay dating army scam
gay dating machismo
gay dating websites for teens
2022/08/30 02:01:49
KyrstinOaOaさん
free gay dating sites grindr craigslist
when a secretive commitment phobic guy you are dating is really gay
best free gay dating sites in florida
2022/08/30 04:52:53
EmaliaOaOaさん
single chat sites
local singles in my area
free dateing sites
2022/08/30 22:22:38
CasandraOaOaさん
top online casino real money
best welcome bonus casino
online casino with free signup bonus real money usa
2022/08/31 02:51:45
KarryOaOaさん
fdating 100 free dating site free
free dating online chat
best dating sites for free
2022/08/31 17:39:46
AmataOaOaさん
bonus casino
real online casino
best online casino for us players
2022/09/01 07:55:23
safetotoさん
From some point on, I am preparing to build my site while browsing various sites. It is now somewhat completed. If you are interested, please come to play with safetoto !!
2022/09/02 08:43:39
uncothithさん
The drug was launched at the end of 2002 for the first time, by Lilly Pharm cialis cheapest online prices
2022/09/02 11:23:08
GennieOaOaさん
gay chat ro
gay chat site
profile tube boys user gay chat boi
2022/09/02 22:17:57
TiesteRatさん
The worldwide prevalence and epidemiology of erectile dysfunction dapoxetina comprar online Some red flags to look for in these emails are misspellings, grammar errors, and links to websites that don t look legitimate
2022/09/03 06:50:43
DeeynOaOaさん
gay chat roulettye
black bottom gay chat room
gay roleplay chat
2022/09/04 02:05:04
EmaleeOaOaさん
chat gay grstis
gay chat safe
older gay chat
2022/09/04 13:59:52
dupdaydayさん
In this way, you will be sure your medications are guaranteed by the FDA to be pure and effective priligy tablets online
2022/09/04 20:40:23
Caulapyさん
In our online checkout you can view shipping options available based on the medication option added buy liquid cialis online
2022/09/04 20:55:27
StephineOaOaさん
teen chat rooms 13-16 gay
cleveland gay chat line numbers
gay chat chat
2022/09/06 12:44:24
Snoseneさん
5 mg cialis generic india Each of your doses will be either individually wrapped or in a bottle, depending on the medication that is prescribed
2022/09/06 16:12:38
Alvenruilaさん
Very good stuff. Appreciate it! thesis writing service how to write narrative essays
2022/09/06 23:03:41
kapcreaspさん
The majority of the other research proposed that PDE5i could be used alone or in combination with other treatments to treat lifelong PE, but these studies had substantial methodological flaws buy cialis non prescription
2022/09/07 02:45:31
Abrahamgonさん
Fine facts. Many thanks! cheapest custom essays papers writing service writing a thesis statement
2022/09/07 14:04:09
RobenaOaOaさん
local gay chat rooms
gay mature chat
gay incest chat
2022/09/08 21:00:04
Expancyさん
Supporting on our well-equipped and prolific processing unit, we are able to feed the bulk requirements of the offered pharmaceutical products in the conventional and effective manner buy cialis generic
2022/09/09 20:40:23
Ownentyさん
thank you so much for sharing ur successful clomid exp. will clomid help deca dick
2022/09/10 04:56:23
TallouOaOaさん
local gay chat room
gay kink chat
chat gay granada
2022/09/10 23:13:54
AlvinJowさん
Seriously tons of excellent advice!
editing essay services https://quality-essays.com/ online writing help for college students
2022/09/11 00:37:00
AlvinJowさん
Kudos! Valuable information.
essay on customer service essay essay writing services reviews
2022/09/11 01:08:31
MarilinOaOaさん
black gay men phone chat
gay tranny webcam chat
gay chat roulette chat
2022/09/12 22:38:11
Dontectさん
So awful in fact it looks at though I walk around with a wet head. 5 mg tamoxifen study
2022/09/14 03:30:03
AlvinJowさん
You actually reported this terrifically!
boston college application essay https://homeworkcourseworkhelps.com/ editing and writing services
2022/09/14 05:16:01
BruceCandyさん
This is nicely expressed. !
north west pharmacy canada navarro pharmacy generic viagra online
2022/09/14 14:52:14
fusaanimiさん
2022/09/14 17:28:25
AlvinJowさん
This is nicely expressed! !
college essay online help essay writing service novel writing helper
2022/09/14 20:29:01
Michaelpedさん
Useful facts. Cheers!
non prescription online pharmacy reviews prescription online canada pharmaceuticals online https://canadianpharmacies-24h.com
2022/09/14 23:22:34
AlvinJowさん
With thanks. Numerous posts.
stanford college essay how to write an argument essay help with speech writing
2022/09/15 04:48:12
AlvinJowさん
You expressed this really well.
how do you cite a website in an essay https://ouressays.com/ websites to write essays
2022/09/15 06:04:56
AlvinJowさん
Truly plenty of useful advice!
essay writer generator https://agbsl.pro/ best resume writing services 2020
2022/09/15 07:38:03
MavisOaOaさん
local single
match single
dating for free
2022/09/15 07:52:25
BruceCandyさん
You reported this really well!
medical pharmacy canada pharmacy no prescription cialis from canada
2022/09/15 17:26:35
AlvinJowさん
Very good posts, Cheers!
writing an admissions essay best writing service best resume writing services nyc
2022/09/15 18:52:44
AlvinJowさん
Whoa lots of fantastic material.
how to write a critical essay write my essay fast ghostwriter review
2022/09/15 21:12:28
BruceCandyさん
Regards. Ample advice.
canadian pharmacy meds canadian pharma companies prescription without a doctor's prescription
2022/09/16 00:52:30
AlvinJowさん
Wow quite a lot of helpful tips.
buy law essay essay typer newsletter writing service
2022/09/16 06:59:41
Wendellunapsさん
Lovely material. Thanks a lot.
order prescriptions online without doctor meds online rx pharmacy
2022/09/16 08:49:46
JuanitaOaOaさん
top single service
online dating sites for free 100%
international dating
2022/09/16 19:09:55
AlvinJowさん
Thanks a lot, I value this!
cambridge essay service essays writers what are the best resume writing services
2022/09/16 20:31:42
AlvinJowさん
You suggested it very well.
harvard essay writing strong college essays cheap essay writing service
2022/09/17 08:04:43
AlvinJowさん
Really a lot of helpful information!
how to write a successful college essay https://topswritingservices.com/ best custom writing website
2022/09/17 09:46:31
MaisieOaOaさん
ourtime login uk
farmers only dating website
dating free
2022/09/17 12:50:32
BruceCandyさん
Terrific stuff. Thanks!
health canada drug database online drugstore canada online pharmacy
2022/09/17 14:42:08
Michaelpedさん
Superb data. Thanks!
canadapharmacy canadian drugstore online canadian pharcharmy online fda approved https://canadianpharmacylist.com
2022/09/17 15:33:43
AlvinJowさん
Great advice. Cheers!
cheap essay help essay writer medical residency personal statement writing services
2022/09/17 22:19:57
AlvinJowさん
Whoa lots of terrific material!
college acceptance essay https://dissertationwritingtops.com/ web copywriting services
2022/09/17 22:51:14
Wendellunapsさん
Many thanks! Loads of information.
canada pharmacies online pharmacy canadian online pharmacies legitimate pharmacy canada
コメントを投稿する
TOP back