Skip to content
Rex Lee(李俊) edited this page Oct 19, 2018 · 2 revisions

接口介绍

前缀 /api/v1

安装

查询应用状态

GET /app/state

response

{
    "ok": true,
    "state": 0
}
state 含义
0 未安装
1 已安装

安装应用

POST /app/install

request

{
    "http_port": 4000,
    "db_type": "mysql",
    "db_host": "127.0.0.1",
    "db_port": 3306,
    "db_name": "blog",
    "db_user": "blog",
    "db_password": ""
}
名称 是否必须 含义
http_port 安装后的 http 服务端口
db_type 数据库类型,支持 mysqlsqlite
db_host mysql 数据库地址
db_port mysql 数据库端口
db_name mysql 数据库名称
db_user mysql 数据库用户名
db_password mysql 数据库密码

response

{
    "ok": true
}

说明

用户请求安装应用接口后,应用安装完成会自动重启

用户

用户登录

POST /user_login

request

{
    "username": "",
    "password": ""
}

response

{
    "ok": true
}
cookie

[sid] --> 0cde1aaa8bb2b5f202c58371bbca9e50

用户登出

POST /admin/user_logout

request(login require)

(empty)

response

{
    "ok": true
}

用户名占用匹配

GET /username_check?username=test

名称 是否必须 含义
username 待匹配的用户名

用户找回密码

POST /user_get_password

用户注册

POST /register

request

{
    "username": "",
    "password": "",
    "email": "",
    "phone": ""
}
名称 是否必须 含义
username 用户名
email Email
password 密码
phone 手机

response

{
    "ok": true
}

文章

添加文章草稿

POST /article

request

{
    "title": "this is a title",
    "content": "this is article content",
    "status": 0
}

发布草稿文章

PUT /article/publish/:id

修改文章

PUT /article/modify/:id

文章列表

GET /article/list

获取文章

GET /article/:id

删除文章

DELETE /article/:id