PHPackages                             api-swoole/sapi - 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 & Networking](/categories/http)
4. /
5. api-swoole/sapi

ActiveLibrary[HTTP & Networking](/categories/http)

api-swoole/sapi
===============

基于swoole实现的一个轻量级框架，支持http、websocket、tcp、udp。

v1.0.2(2y ago)38672[1 issues](https://github.com/liutongke/api-swoole/issues)1PHPPHP >=7.4

Since Sep 7Pushed 1y agoCompare

[ Source](https://github.com/liutongke/api-swoole)[ Packagist](https://packagist.org/packages/api-swoole/sapi)[ RSS](/packages/api-swoole-sapi/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependenciesVersions (6)Used By (1)

赞助商

- 感谢[JetBrains](https://www.jetbrains.com/?from=api-swoole)对本项目的支持！

 [![Top Langs](https://raw.githubusercontent.com/liutongke/liutongke.github.io/master/images/yank-note-picgo-img-20221008020141.png)](https://raw.githubusercontent.com/liutongke/liutongke.github.io/master/images/yank-note-picgo-img-20221008020141.png)

**(一).开始**
==========

[](#一开始)

### **1.1下载与安装**

[](#11下载与安装)

需要确保运行环境达到了以下的要求：

- PHP >= 7.4
- Swoole PHP 扩展 >= 4.5.2
- Redis PHP 扩展 （如需使用 Redis 客户端）
- PDO PHP 扩展 （如需使用 MySQL 客户端）

### **1.2通过 Composer 创建项目**

[](#12通过-composer-创建项目)

```
composer create-project api-swoole/skeleton

```

### **1.3启动**

[](#13启动)

支持 HTTP 服务、WebSocket 服务、tcp服务,项目根目录`./apiswoole.php`执行命令。

```
php apiswoole.php

```

**(二).Hello World**
===================

[](#二hello-world)

### **2.1编写一个接口**

[](#21编写一个接口)

在api-swoole框架中，业务主要代码在app目录中。里面各个命名空间对应一个子目录，项目的默认命名空间是App，创建项目后app目录中包含Common、Example、Ext三个子目录，Common目录存放函数的functions.php文件，Ext一般放置工具等。目录结构如下：

```
./
└── app
    ├── Example # 放置接口源代码，相当于控制器层
    ├── Common # 公共代码目录，
    └── Ext# 放置工具等

```

当项目需要新增接口时，先在`./app/Example`目录中新建`hello.php`文件，并用编辑器编辑代码。

```