Updates api概述.md

Auto commit by GitBook Editor

Updates api概述.md
Auto commit by GitBook Editor
chong
Commit 48070327db9b9362cde172d765f499a9d1d106df 48070327 1 parent cf71319c
Showing 3 changed files with 46 additions and 45 deletions
README.md
SUMMARY.md
api概述.md
--- a/README.md
View file @4807032
+++ b/README.md
View file @4807032
@@ -10,7 +10,7 @@ Welcome to the boxfish developer docs!
 开发过程中需要人工书写changelog，为什么要写它？
-请查看 http://keepachangelog.com/zh-CN/0.3.0/
+请查看 [http://keepachangelog.com/zh-CN/0.3.0/](http://keepachangelog.com/zh-CN/0.3.0/)
 ## OAuth2.0 {#oauth2.0}
@@ -23,3 +23,6 @@ Welcome to the boxfish developer docs!
 1. 200
 2. 401
 3. 500
+
+
+
--- a/SUMMARY.md
View file @4807032
+++ b/SUMMARY.md
View file @4807032
@@ -6,7 +6,6 @@
     * [状态码](README.md#status_code)
 ## 关于用户
-
 * [注册](未整理/注册接口.md)
 * [登录](未整理/登录接口.md)
 * [用户设备绑定](未整理/用户设备绑定.md)
@@ -14,8 +13,10 @@
 * [用户信息](用户相关/用户信息.md)
 * [用户修改真实姓名绑定邮箱](未整理/用户修改真实姓名绑定邮箱.md)
-## 关于获取图书
+## API
+* [API概述](api概述.md)
+## 关于获取图书
 * [书架](未整理/书架.md)
 * [图书目录](未整理/图书目录.md)
 * [课程分类](未整理/课程分类信息查询.md)
@@ -29,8 +30,8 @@
 * [客户端配置](未整理/客户端相关配置接口.md)
 * [教师偏好设置](未整理/教师偏好设置接口.md)
 * [教师偏好获取](未整理/教师偏好获取接口.md)
-* [教师课程目录详细信息(首页使用)](未整理/当前教师偏好下课程目录详细信息获取接口.md)
+* [教师课程目录详细信息\(首页使用\)](未整理/当前教师偏好下课程目录详细信息获取接口.md)
-* [课程目录详细信息(通用版、首页使用)](未整理/当前偏好下课程目录详细信息获取接口.md)
+* [课程目录详细信息\(通用版、首页使用\)](未整理/当前偏好下课程目录详细信息获取接口.md)
 * [教师版系统智能推荐](未整理/教师版系统智能推荐接口.md)
 * [指定班级学生课程学习情况](未整理/指定班级学生课程学习情况接口.md)
 * [获取班级列表信息](未整理/获取班级列表信息.md)
@@ -41,41 +42,33 @@
 * [教师向学生推荐课程](未整理/教师向学生推荐课程.md)
 * [获取尚未指定班级的学生列表](未整理/获取尚未指定班级的学生列表.md)
 * [首页分类模块学习课程数](未整理/首页分类模块学习课程数.md)
-* [分类页面学习课程数(老师学生通用接口)](未整理/分类页面学习课程数老师学生通用接口.md)
+* [分类页面学习课程数\(老师学生通用接口\)](未整理/分类页面学习课程数老师学生通用接口.md)
 ## 关于事件
-
 * [新的事件发送定义（讨论中）](未整理/新的事件发送定义（讨论中）.md)
 ## 关于统计
-
 * [用户单词同步](未整理/用户单词同步.md)
 * [用户积分排行](未整理/用户积分排行.md)
 * [用户每日积分排行](未整理/用户每日积分排行.md)
-
 ## 前端
-
 * [老师版班级管理](未整理/老师版班级管理.md)
 ## 关于客户端
-
 * [通用](客户端/通用.md)
 * [iOS](客户端/iOS.md)
 * [Android](客户端/Android.md)
 * [html5](客户端/html5.md)
 ## 外教版
-
 * [外教版](未整理/外教版.md)
     * [客户端详细](未整理/客户端多国语文案.md)
     * [服务端详细](未整理/服务端多国语文案.md)
 * [外教课程分类数据](未整理/外教课程分类数据.md)
 * [获取下载节点接口](未整理/获取下载节点接口.md)
-
 ## 技术文档
-
 * [服务器接口文档](未整理/服务器接口文档.md)
     * 接口列表
         * [注册接口](未整理/注册接口.md)
@@ -101,33 +94,33 @@
         * [获取oss服务授权接口](未整理/获取oss服务授权接口.md)
         * [获取申请好友接口](未整理/获取申请好友接口.md)
         * [处理微信新旧openId登录接口](未整理/处理微信新旧openId登录接口.md)
-    * [分享今日积分/总积分排名接口](未整理/分享今日积分|总积分排名接口.md)
+        * [分享今日积分\/总积分排名接口](未整理/分享今日积分|总积分排名接口.md)
         * [老师课程推荐 学生端](未整理/老师课程推荐-学生端.md)
         * [老师课程推荐 老师端](未整理/老师课程推荐-老师端.md)
     * 坑
         * [数据库连接池](服务器/数据库连接池.md)
-
 * [模板类型](未整理/模板类型.md)
 * [学生版具体模板介绍](未整理/具体模板介绍.md)
-### 学习模板
+## 学习模板
-  * [单词学习](未整理/单词学习.md)
+* [单词学习](未整理/单词学习.md)
-  * [视频学习](未整理/视频学习.md)
+* [视频学习](未整理/视频学习.md)
-  * [音频学习](未整理/音频学习.md)
+* [音频学习](未整理/音频学习.md)
-  * [纯文章学习](未整理/纯文章学习.md)
+* [纯文章学习](未整理/纯文章学习.md)
-
+
-### 练习模板
+## 练习模板
-  * [看文字选图](未整理/看文字选图.md)
+* [看文字选图](未整理/看文字选图.md)
-  * [听音选图](未整理/听音选图.md)
+* [听音选图](未整理/听音选图.md)
-  * [填空练习](未整理/填空练习.md)
+* [填空练习](未整理/填空练习.md)
-  * [听写练习](未整理/听写练习.md)
+* [听写练习](未整理/听写练习.md)
-
+
-### 考试模板
+## 考试模板
-  * [文字单选题](未整理/文字单选题.md)
+* [文字单选题](未整理/文字单选题.md)
-  * [听音选图片](未整理/听音选图片.md)
+* [听音选图片](未整理/听音选图片.md)
-  * [阅读理解](未整理/阅读理解.md)
+* [阅读理解](未整理/阅读理解.md)
-  * [完形填空](未整理/完形填空.md)
+* [完形填空](未整理/完形填空.md)
-
+
+-----
 * [教师版具体模板介绍](未整理/教师版具体模板介绍.md)
 * [本地存储相关](未整理/本地存储相关.md)
 * [学习统计相关](未整理/学习统计相关.md)
@@ -139,8 +132,8 @@
 * [学情统计](未整理/学情统计.md)
 * [客户端注册登录流程](未整理/客户端注册登录流程.md)
 * [教师上传本课讲授词句及评星情况](未整理/教师上传本课讲授词句及评星情况.md)
-* [全新模板梳理](未整理/全新模板梳理.md) new
+* [全新模板梳理](未整理/全新模板梳理.md)
-* [适配iPhone6P](未整理/适配iPhone6P.md) new
+* [适配iPhone6P](未整理/适配iPhone6P.md)
 * [静态资源下载优化逻辑](未整理/静态资源下载优化逻辑.md)
 * [动态更新分类优化逻辑](未整理/动态更新分类优化逻辑.md)
 * [在线授课相关文档](未整理/在线授课相关文档.md)
@@ -169,8 +162,7 @@
     * [用户发送小文件失败的处理](未整理/用户发送小文件失败的处理.md)
     * [自动上传用户腾讯云日志](未整理/自动上传用户腾讯云日志.md)
     * [常见反馈问题回答](未整理/常见反馈问题回答.md)
-
+* [IOS数据客户端相关文档](未整理/IOS数据客户端.md)
-* [IOS数据客户端相关文档](未整理/IOS数据客户端.md)new
 * [IOS编码规范](未整理/IOS编码规范.md)
 * [Android编码规范](未整理/Android编码规范.md)
 * [教学效果提升](未整理/教学效果提升.md)
@@ -206,7 +198,6 @@
 * [打电话接口](未整理/打电话接口.md)
 ## 产品文档
-
 * [学习行为之听力时长统计 20150708update](未整理/学习行为之听力时长统计.md)
 * [分享 20150710update](未整理/分享.md)
 * [学生版逻辑树 update20150713](未整理/学生版逻辑树-update20150713.md)
@@ -214,7 +205,6 @@
 * [老师版分类上的数据：已学课程](未整理/老师版分类上：已学课程.md)
 ## 测试文档
-
 * [共通测试](未整理/共通测试.md)
 * [学生端测试](未整理/学生端测试.md)
 * [老师端测试](未整理/老师端测试.md)
@@ -231,17 +221,15 @@
         * 新申请的处理
             * [同意学生加入班级](未整理/同意学生加入班级.md)
             * [拒绝学生加入班级](未整理/拒绝学生加入班级.md)
-  * [消息模块](未整理/消息模块.md)
+    * [消息模块](未整理//b消息模块.md)
-  * [个人中心](未整理/个人中心.md)
+    * [个人中心](未整理//b/b个人中心.md)
-  * [其他模块](未整理/其他模块.md)
+    * [其他模块](未整理//b/b其他模块.md)
 * [微信账号升级](未整理/微信账号升级.md)
 ## 客服文档
-
 * [客服电话反馈](未整理/客服电话反馈.md)
 ## 未分类
-
 * [Android-项目](未整理/Android-项目.md)
 * [BoxFishVote项目打包部署操作流程](未整理/BoxFishVote项目打包部署操作流程.md)
 * [IOS-BoxFish-app-推送手机idfa的接口](未整理/IOS-BoxFish-app-推送手机idfa的接口.md)
@@ -255,3 +243,4 @@
 * [网络状态检测](未整理/网络状态检测.md)
 * [网页测试Demo数据](未整理/网页测试Demo数据.md)
 * [获取当前分类下存在的班级](未整理/获取当前分类下存在的班级.md)
+
--- a/api概述.md 0 → 100644
View file @4807032
+++ b/api概述.md 0 → 100644
View file @4807032
+# REST API 基本约束
+
+---
+
+* API被设计为符合HTTP,REST规范。例如：查询请求使用Get方法，提交请求使用Post方法，如果一个请求不是相应的HTTP方法，将返回错误。
+* 如无特殊说明，调用参数值应转码为UTF-8,URL编码
+
+
+