Gao Hanxiang 4935be6f47 refactor: Move skyline-apiserver to libs

1. Move skyline-apiserver to libs
2. Modify Makefile
3. Rename the skyline-apiserver.yaml.sample file to skyline.yaml.sample

At the top level, we use "skyline" as the namespace, using the idea of
monorepo to manage the project. At the top level, only some common
configuration files (mypy.ini, black.conf, isort.conf, etc.) and
common tools are included.

In the `libs` directory, there are three core libraries,
skyline-console, skyline-apiserver, skyline-nginx, and some dependent
libraries.
There are cross-imports between these libraries,
for example: skyline-nginx requires skyline-apiserver;
Both skyline-nginx and skyline-apiserver require skyline-config.

Therefore, skyline-apiserver should not be placed
at the top level, it is also suitable for management as a library.


Change-Id: Ie2f1f4bdfbc2e985ec4327705eecaae3181f5b50

2021-07-26 03:48:54 +00:00

1.3 KiB

Raw Blame History

Skyline API

English | 简体中文

快速开始

依赖工具

make >= 3.82
poetry >= 1.1.0 (安装指南)

开发模式

支持 Linux 和 Mac 操作系统 (推荐 Linux 操作系统) (由于 uvloop 和 cython 库)

安装依赖包
```
make install
```

配置 skyline.yaml 文件

可能你需要根据实际的环境修改以下参数：

- database_url  (你可以设置为 sqlite:////tmp/skyline.db 来使用 sqlite)
- default_region
- keystone_url
- system_project
- system_project_domain
- system_user_domain
- system_user_name
- system_user_password

cp etc/skyline.yaml.sample etc/skyline.yaml
export OS_CONFIG_DIR=$(pwd)/etc

初始化 skyline 数据库
```
make db_sync
```

运行服务

$ poetry run uvicorn --reload --reload-dir libs/skyline-apiserver/skyline_apiserver --port 28000 --log-level debug skyline_apiserver.main:app

INFO:     Uvicorn running on http://127.0.0.1:28000 (Press CTRL+C to quit)
INFO:     Started reloader process [154033] using statreload
INFO:     Started server process [154037]
INFO:     Waiting for application startup.
INFO:     Application startup complete.

此时你可访问在线 API 文档：http://127.0.0.1:28000/docs

1.3 KiB Raw Blame History

Skyline API

快速开始

依赖工具

开发模式

1.3 KiB

Raw Blame History