文件分类操作

创建文件分类

接口

POST https://cloud.minapp.com/oserve/v1/file-category/

参数说明

Content-Type: application/json

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

代码示例

{% tabs createCategoryCurl=”Curl”, createCategoryNode=”Node”, createCategoryPHP=”PHP” %}

{% content “createCategoryCurl” %}

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

{% content “createCategoryNode” %}

  1. var request = require('request');
  3. var opt = {
  4.   uri: 'https://cloud.minapp.com/oserve/v1/file-category/',
  5.   method: 'POST',
  6.   headers: {
  7.     Authorization: `Bearer ${token}`
  8.   },
  9.   json: {   // 指定 data 以 "Content-Type": 'application/json' 传送
  10.     name: 'testCreateFile'
  11.   }
  12. }
  14. request(opt, function(err, res, body) {
  15.   console.log(res.statusCode)
  16. })

{% content “createCategoryPHP” %}

  1. <?php
  2. $param = ['name' =>'nickname'];
  3. $url = 'https://cloud.minapp.com/oserve/v1/file-category/';
  5. $ch = curl_init();
  6. $header = array(
  7.   "Authorization: Bearer {$token}",
  8.   'Content-Type: application/json; charset=utf-8'
  9. );
  11. curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
  12. curl_setopt($ch, CURLOPT_TIMEOUT, 30);
  13. curl_setopt($ch, CURLOPT_URL, $url);
  14. curl_setopt($ch, CURLOPT_POST, true);
  15. curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($param));
  16. curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
  17. curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);
  19. $res['response'] = curl_exec($ch); // 反馈结果
  20. $res['status_code'] = curl_getinfo($ch, CURLINFO_HTTP_CODE); // 请求状态码
  21. curl_close($ch);

{% endtabs %}

状态码说明

201 写入成功

获取分类详情

接口

GET https://cloud.minapp.com/oserve/v1/file-category/:category_id/

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

代码示例

{% tabs getDetailCurl=”Curl”, getDetailNode=”Node”, getDetailPHP=”PHP” %}

{% content “getDetailCurl” %}

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

{% content “getDetailNode”%}

  1. var request = require('request');
  3. var opt = {
  4.   uri: 'https://cloud.minapp.com/oserve/v1/file-category/5a2fe91508443e3123dbe1xx/',  // 5a2fe91508443e3123dbe1xx 对应 uri :category_id
  5.   method: 'GET',
  6.   headers: {
  7.     Authorization: `Bearer ${token}`
  8.   }
  9. }
  11. request(opt, function(err, res, body) {
  12.   console.log(body)
  13. })

{% content “getDetailPHP”%}

  1. <?php
  2. $category_id = '5a2fe91508443e3123dbe1xx'; // 文件分类 ID
  3. $url = "https://cloud.minapp.com/oserve/v1/file-category/{$category_id}/";
  5. $ch = curl_init();
  6. $header = array(
  7.   "Authorization: Bearer {$token}",
  8.   'Content-Type: application/json; charset=utf-8'
  9. );
  11. curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
  12. curl_setopt($ch, CURLOPT_TIMEOUT, 30);
  13. curl_setopt($ch, CURLOPT_URL, $url);
  14. curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
  15. curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
  16. curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);
  18. $res = curl_exec($ch);
  19. curl_close($ch);

{% endtabs %}

返回示例

  1. {
  2.   "files": 0,
  3.   "id": "5a1bb2ed7026d950ca7d2a78",
  4.   "name": "Category 1",
  5.   "created_at": 1511761847,
  6.   "parent": null,
  7.   "subcategories": []
  8. }

获取文件分类列表

接口

GET https://cloud.minapp.com/oserve/v1/file-category/

参数说明

Content-Type: application/json

参数 类型 必填 说明
order_by String N 排序（支持 created_at 进行排序）
limit Number N 限制返回资源的个数，默认为 20 条，最大可设置为 1000
offset Number N 设置返回资源的起始偏移值，默认为 0

代码示例

{% tabs getCategoryCurl=”Curl”, getCategoryNode=”Node”, getCategoryPHP=”PHP” %}

{% content “getCategoryCurl” %}

  1. curl -X GET \
  2. -H "Authorization: Bearer 58f6cd9f84b1b0c04941fbd4d87bc5f14a785107" \
  3. -H "Content-Type: application/json" \
  4. -G \
  5. -d order_by=-created_at \
  6. https://cloud.minapp.com/oserve/v1/file-category/

{% content “getCategoryNode” %}

  1. var request = require('request');
  3. var opt = {
  4.   uri: 'https://cloud.minapp.com/oserve/v1/file-category/',
  5.   method: 'GET',
  6.   headers: {
  7.     Authorization: `Bearer ${token}`
  8.   },
  9.   qs: {     // query string, 被附加到uri的参数
  10.     offset: 0,     // 可选
  11.     limit: 20,     // 可选
  12.     order_by: 'created_at'  // 按照创建时间来排序，可选
  13.   }
  14. }
  16. request(opt, function(err, res, body) {
  17.     console.log(body)
  18. })

{% content “getCategoryPHP”%}

  1. <?php
  2. $url = "https://cloud.minapp.com/oserve/v1/file-category/";
  4. $ch = curl_init();
  5. $header = array(
  6.   "Authorization: Bearer {$token}",
  7.   'Content-Type: application/json; charset=utf-8'
  8. );
  10. curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
  11. curl_setopt($ch, CURLOPT_TIMEOUT, 30);
  12. curl_setopt($ch, CURLOPT_URL, $url);
  13. curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
  14. curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
  15. curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);
  17. $res = curl_exec($ch);
  18. curl_close($ch);

{% endtabs %}

返回示例

  1. {
  2.   "meta": {
  3.     "files": 7,
  4.     "limit": 20,
  5.     "next": null,
  6.     "offset": 0,
  7.     "previous": null,
  8.     "total_count": 1
  9.   },
  10.   "objects": [
  11.     {
  12.       "files": 0,
  13.       "id": "5a1bb2ed7026d950ca7d2a78",
  14.       "name": "Category 1",
  15.       "created_at": 1511761847
  16.     }
  17.   ]
  18. }

字段 files 在返回中有两个地方出现；在 meta 中表示应用上传文件的数量总和；在 objects 中表示每个分类下的上传文件的数量。

修改文件分类

接口

PUT https://cloud.minapp.com/oserve/v1/file-category/:category_id/

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

代码示例

{% tabs modifyCategoryCurl=”Curl”, modifyCategoryNode=”Node”, modifyCategoryPHP=”PHP” %}

{% content “modifyCategoryCurl” %}

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

{% content “modifyCategoryNode” %}

  1. var request = require('request');
  3. var opt = {
  4.   uri: 'https://cloud.minapp.com/oserve/v1/file-category/5a6ad3cffff1d675b9e2cexx/',  // 5a6ad3cffff1d675b9e2cexx 对应 uri :category_id
  5.   method: 'PUT',
  6.   headers: {
  7.     Authorization: `Bearer ${token}`
  8.   },
  9.   json: {   // 指定 data 以 "Content-Type": 'application/json' 传送
  10.     name: 'testCreateFiles'
  11.   }
  12. }
  14. request(opt, function(err, res, body) {
  15.     console.log(res.statusCode)
  16. })

{% content “modifyCategoryPHP” %}

  1. <?php
  2. $category_id = '5a2fe91508443e3123dbe1xx'; // 文件分类 ID
  3. $url = "https://cloud.minapp.com/oserve/v1/file-category/{$category_id}/";
  4. $param['name'] = 'testCreateFiles';
  6. $ch = curl_init();
  7. $header = array(
  8.   "Authorization: Bearer {$token}",
  9.   'Content-Type: application/json; charset=utf-8'
  10. );
  12. curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
  13. curl_setopt($ch, CURLOPT_TIMEOUT, 30);
  14. curl_setopt($ch, CURLOPT_URL, $url);
  15. curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');
  16. curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($param));
  17. curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
  18. curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);
  20. $res['response'] = curl_exec($ch); // 反馈结果
  21. $res['status_code'] = curl_getinfo($ch, CURLINFO_HTTP_CODE); // 请求状态码
  22. curl_close($ch);

{% endtabs %}

返回示例

  1. {
  2.   "files": 0,
  3.   "id": "5a1bb2ed7026d950ca7d2a78",
  4.   "name": "category",
  5.   "created_at": 1511761847
  6. }

状态码说明

200 修改成功

删除文件分类

接口

DELETE https://cloud.minapp.com/oserve/v1/file-category/:category_id/

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

代码示例

{% tabs deleteCategoryCurl=”Curl”, deleteCategoryNode=”Node”, deleteCategoryPHP=”PHP” %}

{% content “deleteCategoryCurl” %}

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

{% content “deleteCategoryNode” %}

  1. var request = require('request');
  3. var opt = {
  4.   uri: 'https://cloud.minapp.com/oserve/v1/file-category/5a6ad3cffff1d675b9e2cexx/',  // 5a6ad3cffff1d675b9e2cexx 对应 uri :category_id
  5.   method: 'DELETE',
  6.   headers: {
  7.     Authorization: `Bearer ${token}`
  8.   }
  9. }
  11. request(opt, function(err, res, body) {
  12.     console.log(res.statusCode)
  13. })

{% content “deleteCategoryPHP” %}

  1. <?php
  2. $category_id = '5a2fe91508443e3123dbe1xx'; // 文件分类 ID
  3. $url = "https://cloud.minapp.com/oserve/v1/file-category/{$category_id}/";
  5. $ch = curl_init();
  6. $header = array(
  7.   "Authorization: Bearer {$token}",
  8.   'Content-Type: application/json; charset=utf-8'
  9. );
  10. curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
  11. curl_setopt($ch, CURLOPT_TIMEOUT, 30);
  12. curl_setopt($ch, CURLOPT_URL, $url);
  13. curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
  14. curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
  15. curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);
  17. $res['response'] = curl_exec($ch); // 反馈结果
  18. $res['status_code'] = curl_getinfo($ch, CURLINFO_HTTP_CODE); // 请求状态码
  19. curl_close($ch);

{% endtabs %}

状态码说明

204 删除成功