Skip to content
/ mini-webapi Public

Web api 用のphp製マイクロフレームワーク

License

MIT license
0 stars 0 forks Branches Tags Activity
Star
Notifications You must be signed in to change notification settings

tekku-taro/mini-webapi

BranchesTags

Repository files navigation

license

Mini-WebAPI

はじめに

このフレームワークはWeb上にREST APIを簡単に構築することを目的に開発されたソフトです。 PHPで作成され、リクエストやリスポンスやデータベースの操作が各クラスで 予め処理されていますので、開発者はそれぞれのエンドポイントでのロジックを記述する だけでAPIサービスを完成させられます。

REST APIについて

REST APIとは、ウェブアップリケーションの機能を外部から呼び出すためのインターフェースの一種です。 RESTの原則に従って設計されるため、REST APIあるいはRESTful APIと呼びます。 REST APIでは、状態管理等を行わず、全てのリクエストがそれ自体で完結した処理を行うこと、URIを通して、全ての情報が一意に表現されていること、リソースの操作には、HTTPメソッド(GET,POST,PUT,DELETE)を利用することなどが定められています。 リクエストを処理した後、結果データをjsonやxmlの形式で返し、通信結果をステータスコードで返します。

主な特徴

  • シンプルで汎用性の高いREST APIを構築できる
  • JWTトークンを使った認証用のAPIが予め組み込まれている
  • Laravelフレームワークでも使われているilluminate/databaseライブラリを利用してモデルクラスで直感的にテーブルデータを操作できる
  • モデルのvalidationルールを簡潔に記述できる
  • APIやモデルクラスの雛形をコマンドラインで作成できる

サーバー・クライアント間のデータフロー

JWT認証とリソースの操作

処理の流れ

  1. クライアントから認証エンドポイント（SessionsAPI）に認証情報を送信

    url:hostname/api/sessions
method:POST
requestBody:{"name":"taro","password":"pass"}

  2. 認証エンドポイントで認証されたらjwtトークンを作成して返す

    "access_token":ACCESSTOKEN_STRING, "refresh_token":REFRESHTOKEN_STRING, "message":"you are ..."

  3. クライアントはサーバー上のリソースエンドポイント（ZipcodesAPI）に向けてリクエストを送信。その際に、jwtトークンの中のアクセストークンをAuthrization Headerにセットする。

    url:hostname/api/zipcodes
あるいは
url:hostname/api/zipcodes/page/2	# 2ページ目を指定する場合
url:hostname/api/zipcodes/1		    # id=1のレコードを取得したい場合

method:GET
Authorization:Bearer ACCESSTOKEN_STRING

  4. リソースエンドポイントではリクエストを処理し、結果をjsonデータで返す

    "data": [
    {
        "id": 1,
        "zipcode": "001-0000",
        "address": "北海道札幌市北区以下に掲載がない場合"
    },
    ...
],
"count": 1000,
"message": "1000 Zipcode records found"

  5. レコードを新規作成する場合は、リクエストメソッドをPOSTに変更し、リクエストボディにレコードのjsonデータを設定して送信する。その際に、jwtトークンの中のアクセストークンをAuthrization Headerにセットする。

    url:hostname/api/zipcodes
method:POST
Authorization:Bearer ACCESSTOKEN_STRING

requestBody:{"zipcode":"001-0010","address":"北海道札幌市北区北十条西（１～４丁目）"}

  6. レコードを更新する場合は、リクエストメソッドをPUTに変更し、リクエストボディにレコードのjsonデータを設定して送信する。その際に、jwtトークンの中のアクセストークンをAuthrization Headerにセットする。

    url:hostname/api/zipcodes/2
method:PUT
Authorization:Bearer ACCESSTOKEN_STRING

requestBody:{"id":2,"zipcode":"001-0010","address":"北海道札幌市北区北十条西（１～４丁目）"}

  7. レコードを削除する場合は、リクエストメソッドをDELETEに変更して送信する。その際に、jwtトークンの中のアクセストークンをAuthrization Headerにセットする。

    url:hostname/api/zipcodes
method:DELETE
Authorization:Bearer ACCESSTOKEN_STRING

  8. アクセストークンの期限が切れた時は、認証エンドポイント（SessionsAPI）にトークンの更新をリクエスト。その際に、jwtトークンの中のリフレッシュトークンをAuthrization Headerにセットする。

    url:hostname/api/sessions
method:PUT
Authorization:Bearer REFRESHTOKEN_STRING

  9. 認証エンドポイントでリフレッシュトークンを検証し、認証されたらjwtトークンを新たに作成して返す

    "access_token":NEW_ACCESSTOKEN, "refresh_token":NEW_REFRESHTOKEN, "message":"you are ..."

  10. セッションを終了する

    url:hostname/api/sessions
method:DELETE
Authorization:Bearer ACCESSTOKEN_STRING

エンドポイントと対応するルート・メソッド一覧

  • 認証エンドポイント： hostname/api/sessions
    • POST：ユーザー認証
    • PUT：トークンの更新
    • DELETE：セッションを終了
  • ユーザー管理：hostname/api/admin/users
    • GET：ユーザーリストの取得（ルートにidがあれば＃idのユーザー情報取得）
    • POST：ユーザー新規作成
    • PUT：ユーザー情報更新
    • DELETE：ユーザー情報の削除
  • 一般API：hostname/api/リソース名(「提供するAPIリスト」に設定された名前)
    • GET：レコードリストの取得（ルートにidがあれば＃idのレコード取得）
    • POST：レコード新規作成
    • PUT：レコード更新
    • DELETE：レコードの削除

ディレクトリ構造

root/api
　├ app
  │  ├── Api                 # APIクラス
  │  │    ├── Admin          # 管理者用API
  │  │    ├── Session        # 認証用API  
  │  |    └── ...            # 一般APIクラス
  │  └── Models              # モデルクラス
  │
　├ bootstrap                 # システム起動時に呼び出すファイル
　├ console                   # コマンドライン用機能
　├ libraries			    # アップリケーション用のライブラリ
　│   ├── AppCore             # コアクラス
  │   └── ...                 # その他のクラス
  │
　├ logs
　├ resources/
  ├ route					# リクエスト処理
　├ tests/
　├ vendor/   
　├ .env						# 設定ファイル
　├ .htaccess  				 # アクセスを全てindex.phpにリダイレクト
　├ index.php
　├ README.md 
　└ その他のフォルダ・ファイル

インストール

# mini-webapiをウェブサーバー上にクローン
git clone https://github.com/tekku-taro/mini-webapi.git

# プロジェクトのディレクトリに移動
cd mini-webapi

# PHPのパッケージをcomposerでインストール
composer install

# resources/webapi.sqlファイルをデータベースにインポートする
mysql -u username -p database_name < webapi.sql

設定

設定ファイル.env

プロジェクトフォルダ内の.envファイルをご自分の環境に合わせて変更してください。

APP_NAME=taro/webapi_fw
# 開発・運用の切り替え
APP_ENV=development    #development/production
# 接続するデータベースの設定
DB_DRIVER=mysql
DB_HOST=127.0.0.1
DB_NAME=webapi
DB_USER=root
DB_PASS=
# 提供するAPIリスト
API=users,sessions,zipcodes
# ログの書き出しのOn/Off
LOG=On # On/Off

エンドポイントの追加

例えば、データベースのstaffsテーブルをリソースにして、操作するエンドポイントの場合

  1. staffsテーブルをデータベースに作成する。

  2. App/Modelsフォルダ内に他のモデルクラスを複製するか、後述の雛形作成方法でEloquentを継承したStaffクラスを作成する。

  3. App/Apiフォルダ内に他の一般APIクラスを複製するか、後述の雛形作成方法でStaffsAPIクラスを作成する。

  4. StaffsAPIにリクエストメソッドに対応したアクションメソッドを作成し、それぞれに必要な処理を記述する。

    • GET : getIndex() または get() # ルートにIDが設定されていれば（cf. api/zipcodes/1） get()に送られる
    • POST : post() # レコードの新規作成
    • PUT : put() # レコードの更新
    • DELETE : delete() # レコードの削除

  5. 設定ファイル( .env )のAPIにAPI名を追加する

    # 提供するAPIリスト
API=users,sessions,zipcodes,staffs	# staffsを追加

アクションメソッドのパラメータ

リクエストの際に、urlに渡されるGETパラメータは、メソッドのパラメータとして取得できます。 例えば、url: hostname/api/zipcodes?zipcode=001-0000ならば

// ZipcodesAPIクラス内
function get($zipcode)
{
    echo $zipcode; // "001-0000"
}

テンプレートから雛形を作成する

コマンドラインまたはbashで、console/maker.batあるいはconsole/maker.shファイルを実行してAPI/Modelファイルの雛形をconsole/outputフォルダ内に作成できます。

作成方法

# 方法１：maker.batを実行
console/maker.bat make:api ZipcodesAPI
console/maker.bat make:model Zipcode # データベース内にzipcodesというテーブルがあることが前提
console/maker.bat make:api SessionsAPI -m User # [-m modelName] オプションで利用するモデルを変更可

# 方法２：maker.shを実行
console/maker.sh make:api ZipcodesAPI
console/maker.sh make:model Zipcode # データベース内にzipcodesというテーブルがあることが前提
console/maker.sh make:api SessionsAPI -m User # [-m modelName] オプションで利用するモデルを変更可

動作環境

  • Apache HTTP Server ( mode_rewrite モジュールを有効化 )
  • PHP 7.2
  • mySql, Maria DB等のPDOで接続できるデータベース

ライセンス (License)

Mini-WebAPIはMIT licenseのもとで公開されています。 Mini-WebAPI is open-source software licensed under the MIT license.

About

Web api 用のphp製マイクロフレームワーク

Topics

php framework micro webapi

Resources

Readme

License

MIT license
Activity

Stars

0 stars

Watchers

1 watching

Forks

0 forks
Report repository

Releases 1

version 1.0.0 Latest
Jan 27, 2020

Packages

No packages published

Contributors 2

  •  
  •  

Languages