API使用说明

MrDoc 目前通过用户在`个人中心`生成用户 token 的方式来支持如下功能：

- 获取文集列表；
- 新建文档；
- 上传图片；
- 获取文集的文档列表[`v0.5.8 版本开始支持`]
- 获取文档详情[`v0.5.8 版本开始支持`]
- 获取版本号[`v0.6.3版本开始支持`]
- 创建文集[`v0.6.4版本开始支持`]

### 必备条件:
- 例如网站地址为:`https://mrdoc.fun` 可以是ip+port形式,也可以是域名.
- TOKEN值:`123456`

#### 请求URL示例为:
- 获取文集列表:<https://mrdoc.fun/api/get_projects/?token=123456>
- 新建文档:<https://mrdoc.fun/api/create_doc/?token=123456>
- 获取文集列表:<https://mrdoc.fun/api/upload_img/?token=123456>
- ...

## 1.如何获取TOKEN?
- 答:你可以在 MrDoc 的【个人中心】-->【Token 管理】页面生成或获取你的用户 token;

## 2.获取文集列表

`GET /api/get_projects/`

- 需要 token

**参数:** 无
**响应:** 返回json格式
```json
{
	'status':true,
	'data':[
		{'id':1,  //文集的ID值
		'name':'jonnyan的博客', //文集名称
		'type':'0'  //文集的访问权限类型,如:0公开/1私密/2指定用户可见/3访问码
		}
	]
}
```
## 3.新建文档

`POST /api/create_doc/`

- 需要 token

**参数:**

| 名称 | 类型 | 是否必选 | 描述 |
| --- | --- | --- | --- |
| pid | string | YES | 文集ID |
| title | string | YES | 文档标题 |
| doc | string | YES | 文档内容 |

**响应:** 返回json格式

```json
{
	'status':true,
	'data':'ok'
}

```

## 4.上传图片

`POST /api/upload_img/`

- 需要 token

**参数:**

| 名称 | 类型 | 是否必选 | 描述 |
| --- | --- | --- | --- |
| data | string | YES | 图片的 base64 编码数据 |

**响应:** 返回json格式

```json
{
'success': 1,
'url': '/media//202101/2021-01-14_182442.png',
'message': '上传图片成功'
}
```

## 5.获取文集的文档列表[`需版本 ≥ 0.5.8`]

`GET /api/get_docs/`

- 需要 token

**参数:**

| 名称 | 类型 | 是否必选 | 描述 |
| --- | --- | --- | --- |
| pid | string | YES | 文集ID |

**响应:** 返回json格式

```json
{'status': True,
'data': [
{
'id': 87, //文档ID
'name': '大机场', //文档名称
'parent_doc': 0, //上级文档
'top_doc': 8, //所属文集ID
'status': 1, //文档状态
'create_time': '2020-12-06T09:56:35.493', //文档创建时间
'modify_time': '2020-12-06T10:10:30.727', //文档修改时间
'create_user': 'admin' //文档创建者
}
]
}
```

## 6.获取单篇文档详情[`需版本 ≥ 0.5.8`]
`GET /api/get_doc/`
- 需要 token

**参数:**

| 名称 | 类型 | 是否必选 | 描述 |
| --- | --- | --- | --- |
| did | string | YES | 文档ID |

**响应:** 返回json格式
```json
{
'status': True,
'data': {
'id': 87, //文档ID
'name': '大机场', //文档名称
'md_content': '文档内容...这里省略, //文档内容
'parent_doc': 0, //上级文档
'top_doc': 8, //所属文集ID
'status': 1, //文档状态
'create_time': '2020-12-06T09:56:35.493',
'modify_time': '2020-12-06T10:10:30.727',
'create_user': 'admin'
}
}

```

## 7.获取版本号[`需版本 ≥ 0.6.3`]
`GET /get_version` 目前唯一不需要token的API

**参数:** 无
**响应:** 返回json格式
```json
{
'status': True,
'data': '0.6.3' //版本号
}
```

## 8.新建文集[`需版本 ≥ 0.6.4`]

`POST /api/create_project/`

- 需要 token

**参数:**

| 名称 | 类型 | 是否必选 | 描述 |
| --- | --- | --- | --- |
| name | string | YES | 文集名称 |
| desc | string | NO | 文集简介 |
| role | string | NO | 文集的访问权限类型(默认1),如:0公开/1私密/2指定用户可见/3访问码 |

**响应:** 返回json格式

```json
{
	'status':true,
	'data':'ok'
}

```

## 9.登录

`GET /api/oauth0/`

- 需要 token

**参数:**

| 名称 | 类型 | 是否必选 | 描述 |
| --- | --- | --- | --- |
| username | string | YES | 用户名 |
| timestamp | string | YES | 时间戳,默认时间差为 3600 秒 |
| randstr | string | YES | 长度大于10位的随机字符串 |
| hashstr | string | YES | hash 校验字符串,md5(randstr + timestamp + username + token) |
| redirecturl | string | NO | 跳转url,为空跳转到 mrdoc 首页 |

**响应:** 无

## 10.获取服务器时间戳

`GET /api/get_timestamp/`

- 需要 token

**参数:** 无

**响应:** 返回json格式

```json
{"status": true, "data": "1615685148"}

```

## python示例代码
```python
import base64
import requests
# 获取文集列表
def get_project():
    request_url='/api/get_projects/'
    url=base_url+request_url+'?token='+apitoken
    print(url)

res=requests.get(url)
    print(res.json())

# 上传图片
def post_image():
	header={'Content-Type':'application/json'}
    image=open(r'1.jpg','rb')
    encode_image=base64.b64encode(image.read())
	image.close()

request_url = '/api/upload_img/'
    url=base_url+request_url+'?token='+apitoken
    print(url)
    playload={
        'data':encode_image,
    }
    res=requests.post(url,data=playload,headers=header)
    print(res.json())

if __name__ == '__main__':
    apitoken = '123456'
    base_url = 'https://www.mrdoc.fun'
	get_project()
	post_image()
```