mirror of
https://gitee.com/iresty/apisix.git
synced 2024-12-15 09:21:26 +08:00
113 lines
2.5 KiB
Markdown
113 lines
2.5 KiB
Markdown
# 开发者手册
|
||
|
||
## 在开发环境搭建 APISIX
|
||
|
||
不同系统有不同依赖，查看[安装依赖](doc/install-dependencies.md)完成依赖项安装。
|
||
|
||
如果你是开发人员，可以在完成上面安装依赖项后，通过下面的命令快速搭建本地开发环境。
|
||
|
||
```shell
|
||
# clone project
|
||
git clone git@github.com:iresty/apisix.git
|
||
cd apisix
|
||
|
||
# init submodule
|
||
git submodule update --init --recursive
|
||
|
||
# install dependency
|
||
make dev
|
||
```
|
||
|
||
如果一切顺利，你会在最后看到这样的信息：
|
||
|
||
> Stopping after installing dependencies for apisix
|
||
|
||
下面是预期的开发环境目录结构：
|
||
|
||
```shell
|
||
$ tree -L 2 -d apisix
|
||
apisix
|
||
├── benchmark
|
||
│ ├── fake-apisix
|
||
│ └── server
|
||
├── bin
|
||
├── conf
|
||
│ └── cert
|
||
├── dashboard
|
||
│ ├── css
|
||
│ ├── fonts
|
||
│ ├── img
|
||
│ ├── js
|
||
│ └── tinymce
|
||
├── deps # 依赖的 Lua 和动态库，放在了这里
|
||
│ ├── lib64
|
||
│ └── share
|
||
├── doc
|
||
│ ├── images
|
||
│ └── plugins
|
||
├── logs
|
||
├── lua
|
||
│ └── apisix
|
||
├── rockspec
|
||
├── t
|
||
│ ├── admin
|
||
│ ├── config-center-yaml
|
||
│ ├── core
|
||
│ ├── lib
|
||
│ ├── node
|
||
│ ├── plugin
|
||
│ ├── router
|
||
│ └── servroot
|
||
└── utils
|
||
```
|
||
|
||
## 管理（启动、关闭等）APISIX 服务
|
||
|
||
我们可以在 apisix 的目录下用 `make run` 命令来启动服务，或者用 `make stop` 方式关闭服务。
|
||
|
||
```shell
|
||
# init nginx config file and etcd
|
||
$ make init
|
||
./bin/apisix init
|
||
./bin/apisix init_etcd
|
||
|
||
# start APISIX server
|
||
$ make run
|
||
|
||
# stop APISIX server
|
||
$ make stop
|
||
|
||
# more actions find by `help`
|
||
$ make help
|
||
Makefile rules:
|
||
|
||
help: Show Makefile rules.
|
||
dev: Create a development ENV
|
||
dev_r3: Create a development ENV for r3
|
||
check: Check Lua source code
|
||
init: Initialize the runtime environment
|
||
run: Start the apisix server
|
||
stop: Stop the apisix server
|
||
clean: Remove generated files
|
||
reload: Reload the apisix server
|
||
install: Install the apisix
|
||
test: Run the test case
|
||
```
|
||
|
||
## 运行测试案例
|
||
|
||
在你本地运行测试案例：
|
||
|
||
```shell
|
||
make test
|
||
```
|
||
|
||
下面是运行测试的依赖项：
|
||
|
||
* Nginx: version >= 1.4.2
|
||
|
||
* Perl modules:
|
||
`Test::Nginx` https://github.com/openresty/test-nginx
|
||
|
||
更多细节，可以参考 [travis.yml](.travis.yml).
|