# 文件分类操作

## 创建文件分类

**接口**

`POST https://cloud.minapp.com/oserve/v2.2/file-category/`

**参数说明**

Content-Type: `application/json`

| 参数   | 类型     | 必填 | 说明      |
| ---- | ------ | -- | ------- |
| name | String | Y  | 文件分类的名称 |

**代码示例**

```
curl -X POST \
-H "Authorization: Bearer 58f6cd9f84b1b0c04941fbd4d87bc5f14a785107" \
-H "Content-Type: application/json" \
-d '{"name": "Category"}' \
https://cloud.minapp.com/oserve/v2.2/file-category/
```

```js
var request = require('request');

var opt = {
  uri: 'https://cloud.minapp.com/oserve/v2.2/file-category/',
  method: 'POST',
  headers: {
    Authorization: `Bearer ${token}`
  },
  json: {   // 指定 data 以 "Content-Type": 'application/json' 传送
    name: 'testCreateFile'
  }
}

request(opt, function(err, res, body) {
  console.log(res.statusCode)
})
```

```php
<?php
$param = ['name' =>'nickname'];
$url = 'https://cloud.minapp.com/oserve/v2.2/file-category/';

$ch = curl_init();
$header = array(
  "Authorization: Bearer {$token}",
  'Content-Type: application/json; charset=utf-8'
);

curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
curl_setopt($ch, CURLOPT_TIMEOUT, 30);
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($param));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);

$res['response'] = curl_exec($ch); // 反馈结果
$res['status_code'] = curl_getinfo($ch, CURLINFO_HTTP_CODE); // 请求状态码
curl_close($ch);
```

**状态码说明**

`201` 写入成功

## 获取分类详情

**接口**

`GET https://cloud.minapp.com/oserve/v2.2/file-category/:category_id/`

其中 `:category_id` 需替换为你的文件分类 ID

**代码示例**

```
curl -X GET \
-H "Authorization: Bearer 58f6cd9f84b1b0c04941fbd4d87bc5f14a785107" \
-H "Content-Type: application/json" \
https://cloud.minapp.com/oserve/v2.2/file-category/5a1bb2ed7026d950ca7d2a78/
```

```js
var request = require('request');

var opt = {
  uri: 'https://cloud.minapp.com/oserve/v2.2/file-category/5a2fe91508443e3123dbe1xx/',  // 5a2fe91508443e3123dbe1xx 对应 uri :category_id
  method: 'GET',
  headers: {
    Authorization: `Bearer ${token}`
  }
}

request(opt, function(err, res, body) {
  console.log(body)
})
```

```php
<?php
$category_id = '5a2fe91508443e3123dbe1xx'; // 文件分类 ID
$url = "https://cloud.minapp.com/oserve/v2.2/file-category/{$category_id}/";

$ch = curl_init();
$header = array(
  "Authorization: Bearer {$token}",
  'Content-Type: application/json; charset=utf-8'
);

curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
curl_setopt($ch, CURLOPT_TIMEOUT, 30);
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);

$res = curl_exec($ch);
curl_close($ch);
```

**返回示例**

```json
{
  "files": 0,
  "id": "5a1bb2ed7026d950ca7d2a78",
  "name": "Category 1",
  "created_at": 1511761847,
  "parent": null,
  "subcategories": []
}
```

## 获取文件分类列表

**接口**

`GET https://cloud.minapp.com/oserve/v2.2/file-category/`

> **info** 该接口支持通过参数 return\_total\_count 指定是否返回查询对象总数，以协助不关心对象总数只关心查询结果列表的开发者提升接口响应速度。 同时，从 v2.2 版本开始该接口默认不返回查询对象总数，欲获取总数的开发者需要显式指定 return\_total\_count 参数。

**参数说明**

Content-Type: `application/json`

| 参数                   | 类型     | 必填 | 说明                                              |
| -------------------- | ------ | -- | ----------------------------------------------- |
| order\_by            | String | N  | 排序（支持 `created_at` 进行排序）                        |
| limit                | Number | N  | 限制返回资源的个数，默认为 20 条，最大可设置为 1000                  |
| offset               | Number | N  | 设置返回资源的起始偏移值，默认为 0                              |
| return\_total\_count | Number | N  | 返回结果 meta 中是否返回 total\_count，1 为返回，0 为不返回，默认不返回 |

若开发者只需要获取对象总数，则可以通过设置 `limit=1` 以及 `return_total_count=1` 来达到该效果，total\_count 可从返回的 meta 中获取

请求示例：

```
https://cloud.minapp.com/oserve/v2.2/file-category/?limit=1&return_total_count=1
```

**代码示例**

```
curl -X GET \
-H "Authorization: Bearer 58f6cd9f84b1b0c04941fbd4d87bc5f14a785107" \
-H "Content-Type: application/json" \
-G \
-d order_by=-created_at \
https://cloud.minapp.com/oserve/v2.2/file-category/
```

```js
var request = require('request');

var opt = {
  uri: 'https://cloud.minapp.com/oserve/v2.2/file-category/',
  method: 'GET',
  headers: {
    Authorization: `Bearer ${token}`
  },
  qs: {     // query string, 被附加到uri的参数
    offset: 0,     // 可选
    limit: 20,     // 可选
    order_by: 'created_at'  // 按照创建时间来排序，可选
  }
}

request(opt, function(err, res, body) {
    console.log(body)
})
```

```php
<?php
$url = "https://cloud.minapp.com/oserve/v2.2/file-category/";

$ch = curl_init();
$header = array(
  "Authorization: Bearer {$token}",
  'Content-Type: application/json; charset=utf-8'
);

curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
curl_setopt($ch, CURLOPT_TIMEOUT, 30);
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);

$res = curl_exec($ch);
curl_close($ch);
```

**返回示例**

```json
{
  "meta": {
    "files": 7,
    "limit": 20,
    "next": null,
    "offset": 0,
    "previous": null,
    "total_count": 1
  },
  "objects": [
    {
      "files": 0,
      "id": "5a1bb2ed7026d950ca7d2a78",
      "name": "Category 1",
      "created_at": 1511761847
    }
  ]
}
```

字段 `files` 在返回中有两个地方出现；在 `meta` 中表示应用上传文件的数量总和；在 `objects` 中表示每个分类下的上传文件的数量，同时字段 `files` 从 v2.2 版本开始仅在 return\_total\_count 为 1 时返回。

## 修改文件分类

**接口**

`PUT https://cloud.minapp.com/oserve/v2.2/file-category/:category_id/`

其中 `:category_id` 需替换为你的文件分类 ID

**代码示例**

```
curl -X PUT \
-H "Authorization: Bearer 58f6cd9f84b1b0c04941fbd4d87bc5f14a785107" \
-H "Content-Type: application/json" \
-d '{"name": "category"}' \
https://cloud.minapp.com/oserve/v2.2/file-category/5a1bb2ed7026d950ca7d2a78/
```

```js
var request = require('request');

var opt = {
  uri: 'https://cloud.minapp.com/oserve/v2.2/file-category/5a6ad3cffff1d675b9e2cexx/',  // 5a6ad3cffff1d675b9e2cexx 对应 uri :category_id
  method: 'PUT',
  headers: {
    Authorization: `Bearer ${token}`
  },
  json: {   // 指定 data 以 "Content-Type": 'application/json' 传送
    name: 'testCreateFiles'
  }
}

request(opt, function(err, res, body) {
    console.log(res.statusCode)
})
```

```php
<?php
$category_id = '5a2fe91508443e3123dbe1xx'; // 文件分类 ID
$url = "https://cloud.minapp.com/oserve/v2.2/file-category/{$category_id}/";
$param['name'] = 'testCreateFiles';

$ch = curl_init();
$header = array(
  "Authorization: Bearer {$token}",
  'Content-Type: application/json; charset=utf-8'
);

curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
curl_setopt($ch, CURLOPT_TIMEOUT, 30);
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($param));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);

$res['response'] = curl_exec($ch); // 反馈结果
$res['status_code'] = curl_getinfo($ch, CURLINFO_HTTP_CODE); // 请求状态码
curl_close($ch);
```

**返回示例**

```json
{
  "files": 0,
  "id": "5a1bb2ed7026d950ca7d2a78",
  "name": "category",
  "created_at": 1511761847
}
```

**状态码说明**

`200` 修改成功

## 删除文件分类

**接口**

`DELETE https://cloud.minapp.com/oserve/v2.2/file-category/:category_id/`

其中 `:category_id` 需替换为你的文件分类 ID

**代码示例**

```
curl -X DELETE \
-H "Authorization: Bearer 58f6cd9f84b1b0c04941fbd4d87bc5f14a785107" \
-H "Content-Type: application/json" \
https://cloud.minapp.com/oserve/v2.2/file-category/5a1bb2ed7026d950ca7d2a78/
```

```js
var request = require('request');

var opt = {
  uri: 'https://cloud.minapp.com/oserve/v2.2/file-category/5a6ad3cffff1d675b9e2cexx/',  // 5a6ad3cffff1d675b9e2cexx 对应 uri :category_id
  method: 'DELETE',
  headers: {
    Authorization: `Bearer ${token}`
  }
}

request(opt, function(err, res, body) {
    console.log(res.statusCode)
})
```

```php
<?php
$category_id = '5a2fe91508443e3123dbe1xx'; // 文件分类 ID
$url = "https://cloud.minapp.com/oserve/v2.2/file-category/{$category_id}/";

$ch = curl_init();
$header = array(
  "Authorization: Bearer {$token}",
  'Content-Type: application/json; charset=utf-8'
);
curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
curl_setopt($ch, CURLOPT_TIMEOUT, 30);
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);

$res['response'] = curl_exec($ch); // 反馈结果
$res['status_code'] = curl_getinfo($ch, CURLINFO_HTTP_CODE); // 请求状态码
curl_close($ch);
```

**状态码说明**

`204` 删除成功