PHPackages                             socket-manager/rest-api - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [HTTP &amp; Networking](/categories/http)
4. /
5. socket-manager/rest-api

ActiveProject[HTTP &amp; Networking](/categories/http)

socket-manager/rest-api
=======================

PHP製のREST-API/RESTful-APIサーバー開発環境。PSR-7準拠、ステートマシン対応、ChunkedやSSEなどの高度なAPI処理をサポート。

v1.6.8(3w ago)19MITPHP

Since Dec 20Pushed 3w agoCompare

[ Source](https://github.com/socket-manager/rest-api)[ Packagist](https://packagist.org/packages/socket-manager/rest-api)[ RSS](/packages/socket-manager-rest-api/feed)WikiDiscussions main Synced today

READMEChangelog (10)Dependencies (8)Versions (19)Used By (0)

**REST-API-PROJECT：REST-API / RESTful-API サーバー開発環境（PHP × PSR-7 × State Machine）**
=================================================================================

[](#rest-api-projectrest-api--restful-api-サーバー開発環境php--psr-7--state-machine)

本プロジェクトは、REST-API および RESTful-API を高速かつ柔軟に構築するための PHP 製クロスプラットフォーム対応サーバー開発環境です。
SOCKET-MANAGER Framework をベースに、PSR-7準拠のHTTPメッセージ、イベント駆動、ステートマシン、Chunked Transfer、SSE など、モダンなAPI開発に必要な機能を網羅しています。

REST-API / RESTful-API の両方に最適化された構成により、拡張性の高い API サーバーを効率的に構築できます。

---

【 特徴 】
======

[](#-特徴-)

REST-API / RESTful-API 対応
-------------------------

[](#rest-api--restful-api-対応)

標準的な REST-API 設計に加え、RESTful-API の思想に沿ったリソース指向の実装にも対応しています。
PHP が動作する環境であれば OS を問わず利用できます。

クロスプラットフォーム（PHP環境）
------------------

[](#クロスプラットフォームphp環境)

Linux / macOS / Windows など、PHP が動作する環境であれば同一の開発体験を提供します。

PSR-7準拠のリクエスト／レスポンス
-------------------

[](#psr-7準拠のリクエストレスポンス)

本プロジェクトは PSR-7（HTTP Message Interface）に準拠しており、
REST-API / RESTful-API の標準的な実装と高い互換性を持ちます。

OAuth2 などの PSR-7 対応認証モジュールとも連携可能です。

PSR-7 公式仕様：

PSR-7 ラッパーの詳細な使い方はこちら：

SOCKET-MANAGER Framework 製
--------------------------

[](#socket-manager-framework-製)

SOCKET-MANAGER Framework が持つビルトインのステートマシンにより、
REST-API / RESTful-API の実装方式を柔軟に選択できます。

---

【 実装形態 】
========

[](#-実装形態-)

1. イベントハンドラタイプ
--------------

[](#1-イベントハンドラタイプ)

単一ハンドラで REST-API を実装するシンプルな方式です。
一般的な RESTful-API の CRUD 実装に最適です。

2. ステートマシンタイプ
-------------

[](#2-ステートマシンタイプ)

UNIT（状態）単位で処理を分割する方式で、以下のような REST-API / RESTful-API の高度な処理に最適です。

- Chunked Transfer（チャンク転送）
- Server-Sent Events（SSE）
- Range送信
- IPC（サーバー間通信）
- 長時間接続・分割送信が必要なAPI

通常のサーバー設定では単一ハンドラでまとめて送信されがちなチャンク転送も、
ステートマシンタイプではほぼ確実に分割送信されます。

### Chunked Transfer デモ（分割送信）

[](#chunked-transfer-デモ分割送信)

ステートマシンタイプでは、Chunked Transfer による分割送信が確実に行われます。
以下の GIF アニメでは、5秒間隔でチャンクが送信される様子を確認できます。

[![Chunked Transfer による5秒間隔の分割送信デモ](./public/img/chunked.gif "Chunked Transfer の分割送信動作（5秒間隔）")](./public/img/chunked.gif)

### SSE（再接続対応）デモ

[](#sse再接続対応デモ)

Server-Sent Events（SSE）では、クライアントが切断された場合でも再接続後に続きから受信できます。
以下の GIF アニメでは、接続断 → 再接続 → 続きのイベント受信までの流れを確認できます。

[![SSE の再接続後に続きを受信するデモ](./public/img/sse.gif "SSE の再接続とイベント受信の継続動作")](./public/img/sse.gif)

---

【 サンプル 】
========

[](#-サンプル-)

REST-API / RESTful-API の動作確認ができるサンプルを同梱しています。
イベントハンドラタイプ／ステートマシンタイプの両方を用意しています。

ユーザー情報操作（CRUD）
--------------

[](#ユーザー情報操作crud)

- GET: ユーザー一覧取得
- POST: 新規ユーザー作成
- PUT: ユーザー全体更新
- PATCH: ユーザー部分更新
- DELETE: ユーザー削除

Multipart アップロード
----------------

[](#multipart-アップロード)

- アップロード済みファイルの確認
- Multipart形式でのファイルアップロード

Chunked アップロード
--------------

[](#chunked-アップロード)

- Chunkedアップロード済みファイルの確認
- curlコマンドによるアップロード（ブラウザ制約回避のため）

チャンク転送デモ
--------

[](#チャンク転送デモ)

SSE（再接続対応）デモ
------------

[](#sse再接続対応デモ-1)

Rangeヘッダを使った分割送信デモ
------------------

[](#rangeヘッダを使った分割送信デモ)

---

【 ドキュメント 】
==========

[](#-ドキュメント-)

本 README では概要とサンプルを中心に紹介しています。
実装方式（イベントハンドラ型 / ステートマシン型）、PSR-7 ラッパー、ルーティング、Chunked / SSE / Range 送信などの詳細仕様は
以下の公式ドキュメントにまとめています。

REST-API サーバー開発環境ドキュメント：

---

【 導入方法 】
========

[](#-導入方法-)

以下のコマンドで REST-API / RESTful-API 開発環境を作成します。

```
composer create-project socket-manager/rest-api

```

---

【 サンプルの起動方法 】
=============

[](#-サンプルの起動方法-)

1. サーバー起動
---------

[](#1-サーバー起動)

REST-API / RESTful-API の実装方式を選択して起動できます。

### イベントハンドラタイプ

[](#イベントハンドラタイプ)

```
php worker app:event-handler-sample

```

### ステートマシンタイプ

[](#ステートマシンタイプ)

```
php worker app:state-machine-sample

```

2. ブラウザでサンプル画面を表示
-----------------

[](#2-ブラウザでサンプル画面を表示)

```
http://localhost:10000/sample.html

```

※ サンプルサーバーが Web サーバーを兼ねているため、別途 Web サーバーは不要です。
※ ドキュメントルートは `./setting/parameter-sample.php` で変更可能（デフォルト：`public/`）。

---

【 Contact Us 】
==============

[](#-contact-us-)

バグ報告やご要望などは[`こちら`](mailto:lib.tech.engineer@gmail.com)から受け付けております。

---

【 License 】
===========

[](#-license-)

MIT, see [LICENSE file](https://github.com/socket-manager/new-project/blob/main/LICENSE).

###  Health Score

39

—

LowBetter than 84% of packages

Maintenance92

Actively maintained with recent releases

Popularity5

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity44

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~9 days

Recently: every ~27 days

Total

18

Last Release

27d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/166518763?v=4)[socket-manager](/maintainers/socket-manager)[@socket-manager](https://github.com/socket-manager)

---

Top Contributors

[![socket-manager](https://avatars.githubusercontent.com/u/166518763?v=4)](https://github.com/socket-manager "socket-manager (18 commits)")

---

Tags

api-serverasyncchunked-transfercross-platformevent-drivenhttp-messagemultipart-uploadnon-blockingphpphp-rest-apipsr-7range-requestrest-apirestful-apiserver-sent-eventssocket-managerssestate-machineweb-apipsr-7http-messageasyncnon-blockingevent-drivenoauth2sseREST APIRESTful APIstate-machinephp frameworkcross-platformweb-apiapi-serveripcserver sent eventssocket-managermultipart-uploadphp-rest-apichunked-transferrange-requeststreaming-api

### Embed Badge

![Health badge](/badges/socket-manager-rest-api/health.svg)

```
[![Health](https://phpackages.com/badges/socket-manager-rest-api/health.svg)](https://phpackages.com/packages/socket-manager-rest-api)
```

###  Alternatives

[psr/http-message

Common interface for HTTP messages

7.0k1.1B6.9k](/packages/psr-http-message)[react/http

Event-driven, streaming HTTP client and server implementation for ReactPHP

78127.7M465](/packages/react-http)[symfony/psr-http-message-bridge

PSR HTTP message bridge

1.3k320.9M979](/packages/symfony-psr-http-message-bridge)[fig/http-message-util

Utility classes and constants for use with PSR-7 (psr/http-message)

39397.5M312](/packages/fig-http-message-util)[amphp/http-server

A non-blocking HTTP application server for PHP based on Amp.

1.3k6.7M109](/packages/amphp-http-server)[amphp/http-client

An advanced async HTTP client library for PHP, enabling efficient, non-blocking, and concurrent requests and responses.

7309.5M202](/packages/amphp-http-client)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
