More than 3 years have passed since last update.

【初心者向け】RESTfulAPIを作るには？

Posted at 2021-07-25

Page 1 of 15

RESTful APIとは？

REpresentational State Transfer の略です。
よくRESTと言われます。

アプリケーションプログラミングインタフェースと言われます。
ざっくり言うと、外部向けに機能を公開したものです。
有名なものといえばGoogle Maps APIでしょうか。

大雑把に言ってしまうと

の２つです。

基本的にはJSONで送受信します。
（xmlで通信する場合もあるかもしれません）
URLに何らかのIDをパラメーターとして埋め込む場合も多々あります。

基本的に

のどちらかで通信します。

ExcelでAPI設計書等を作る必要があるかと思いますが
Swaggerを利用すると開発中にも試せて色々便利です。

の書き方が可能です。

書き方がSwagger v2と変わるので、好き嫌いは分かれるかもしれませんが…
host（通信先）が複数定義できます。
AWSで送信先のAPI Gatewayが違う場合、いちいち送信先を書き換える必要が無くなるのでこちらが便利です。

Swagger UI等でHTMLドキュメントとして出力することも可能です。
自社サービスであれば、こちらの方が色々と楽です。

基本的には非同期通信処理で実行します。

などを利用して通信することが多いです。
（もちろん上記以外もあると思います。）

preflightでOPTIONSが送信される場合もあります。

例えばユーザーを削除したい場合は
～～/user/{userId}/deleteのようなURLを定義するのではなく
～～/user/{userId}に対して、MethodをDELETEで送信する。

情報を取得したい場合は
～～/user/{userId}に対して、MethodをGETで送信する。

上記のように、同じURLに対してどう操作するかをMethodで決めること。

API側はセッションを利用しないこと

REST APIは原則ステートレスであることとします。
そのため、セッション等でサーバー側に情報を保持しておくことはしません。