当前课程知识点：软件开发实训--动态网站开发 > 3 接口设计 > 3.4内容接口设计 > 3.4.1内容接口设计
同学
你好
欢迎回到软件开发实训课堂
上节课咱们对导航菜单的接口做了一个说明
如何去设计每一个接口
你心里一定要有一个明确的方式
有了导航菜单的设计
那么对于内容接口的设计
你应该有一个明确的意识
能够知道如何去把内容中数据库的数据转换成
我们的JSON数据
那么JSON的格式该怎么做
这就是我们接口设计需要考虑的
那么设计时JSON的格式是以数组开始
还是以对象开始
也需要你去说明
在文档里写清楚
而数据中的每一个字段也需要很明确的说明
那么内容接口它包括哪些东西呢
这个要注意一点内容
不光是显示的文章内容
通知等这样的信息
还需要有它的分类信息
所以在设计接口时你要考虑到
那么我们来看一下
首先看一下单个内容的接口设计
什么叫单个内容呢
比如说我对一篇文章的数据的请求
这就是单个内容
那么对于单个内容
你可以使用的请求方式
用Get请求
也可以用post请求
这里为了演示post的请求
咱们对于单内容的请求
用post的方法去请求
他所需要的参数内容ID我们把它作为一条
唯一标识的信息传递给服务器
这个时候服务器得到信息后
会去数据库查找对应的ID值
如果找到了
它就会返回对应的数据
那么返回我们首先说请求的路径是什么呢
content
这是我们前面约定好的关键字
路径有了
ID有了服务器返回JSON
那么注意了
它是单条数据
单条数据
所以我们在返回的时候只需要考虑用对象就可以了
一条数据一条内容
只需要用一个对象来表示就可以了
这里我们就完全使用大括号开始
就说明我们是一个对象
每一个关键字
CAD开头等等
这都是来自后台数据库的相关字段
都会有
根据这些字段
你可以单条的去显示它的概要
或者详细的内容
主要就是看你对数据的应用
这是有关单条内容
那么在我们的网站首页
往往表现的内容形式比较多
有时候我们使用列表形式
有时候我们使用文章加图片的概要形式
那么获取的方法我们这里用get就行了
因为我们不需要太隐秘的数据传递
请求的路径
我们约定为HC
H代表了home
而C代表了内容
所以我们这个是什么
首页内容
flag标识
这是给他传递的一个信息
就是说我在请求的时候
我请求的是哪一类型的数据
比如说我是热门信息还是置顶信息
还是滚动信息
还是什么通知等等
这些个内容都通过flag来进行区别
那么它返回的依然是JSON数据
但是对于前端的首页来讲
它的每一个内容区域内容不仅仅是一条
往往都是一个列表形式
所以我们使用了数组形式来返回数据
也就是我们说的中括号开始
而中括号里边的每一个元素是大括号说明是
每个对象
因此把对象作为数组的元素返回
这就是把前面单条信息给它融合到了一起
但是你要注意
对于首页
它往往不需要详细内容
只需要概要
所以我们在返回的时候你要注意
content
这个内容不需要全部返回
只需要返回一部分
比如说前面200个字符等等
去限制他
以提升我们传递数据的效率
速度等等
所以在处理这个content时要注意一下
这个需要你在设计的时候
也要考虑到
这是首页的相关内容需求
那么刚才我们也说了
对于内容来讲
你不仅仅只考虑到文章通知这样的具体的内容
而还要考虑的就是这些内容的分类
比如说是产品信息内容
还是公司的最新通知
还有最新的下载的相关资料等等
那么这些个都需要接口来设计
那么我们来看一下获取分类时我们使用的方法
是get请求方法
如果我们在请求某个单层分类的具体的文章信息时
还需要传递给他一个分类编号
这个要注意
然后注意请求路径是cententtype
cententtype
如果你在前端需要所有的分类信息
你就可以用肯cententtype返回所有的信息
然后通过分类编号来区别返回单个分类下面的
文章信息
那么这里我们所说的分类接口
就是返回单个分类ID所对应的内容列表信息
看一下它的返回结果JSON
它的结果也是一个中括号开始
那就说明它返回的是一个数组
也就是多个内容信息
而每一个具体的元素就是需要的相关分类的信息
这里边我们并没有出现content这个字段
centent的字段是具体的内容
而对于分类来讲
往往我们只需要显示它的标题以及它发布的
时间等等
再有可能我们需要一张标题图片来展示我们的
相关内容
这个时候我们根本用不着centent
所以在生成内容时
生成JSON格式的数据时
要注意把centent去掉
因为它的内容量很大
有它和没它数据量明显的有区别
所以在这种简易的数据里把centent去掉就可以了
这样我们在显示分类的下面的信息时
就很容易地获取到了相关的检疫信息
这是有关分类接口的实现
有了这个分类的接口以及我们的内容接口
这样在前台需要的所有的有关分类和内容的信息
就都有了
当然如果这些个还不能满足你的需求
比如说你需要专门的产品内容的接口
那么还需要你去把它写出来
那么这些信息写出来后
一定要把它放到你的设计文档之中
有了这些在后期团队合作时才能够无缝衔接
这使得后台和前台能够完全彻底的分离
这也就是为什么现在招聘岗位时
会有WEB前端工程师和后端工程师的区别
前端工程师只需要考虑前端的相关内容就可以了
那么有了这个设计
我们就等于是说把前端和后端进行了一个完美的约定
大家都遵守约定
遵守这样的数据格式
就可以
在相互的协作下完成一个网站的开发
好
这节课就讲到这里
下节课咱们再见
-1.1课程介绍
--1.1.3随堂测试
-1.2网站需求分析
--1.2.4随堂测试
-1.3网站首页分析
--1.3.3随堂测试
-1.4导航菜单分析
--1.4.3随堂测试
-1.5内容区域分析
--1.5.3随堂测试
-1.6内容副页面分析
-1.7编写需求文档
-2.1后端页面总体分析
--2.1.3随堂测试
-2.2用户管理功能设计
--2.2.3随堂测试
-2.3内容与分类功能分析
--2.3.3随堂测试
-2.4网站配置功能设计
--2.4.4随堂测试
-2.5数据库及表结构分析
-总体设计文档
-3.1前台模板约定
--3.1.3随堂测试
-3.2网站配置接口设计
--3.2.3随堂测试
-3.3菜单接口设计
--3.3.3随堂测试
-3.4内容接口设计
--3.4.3随堂测试
-3.5幻灯片接口设计
--3.5.3随堂测试
-补充设计文档
-4.1用户管理功能设计
--4.1.3随堂测试
-4.2菜单管理功能设计
--4.2.3随堂测试
-4.3内容管理功能设计
--4.3.3随堂测试
-4.4网站配置信息设计
--4.4.3随堂测试
-完成设计文档
-4.6随堂测试
-5.1开发环境搭建
--5.1.2随堂测试
-5.2Web前端环境搭建
-5.3创建用户实体
--5.3.2随堂测试
-5.4用户实体表创建与初始化
--5.4.2随堂测试
-5.5用户数据访问接口实现
--5.5.2随堂测试
-5.6环境搭建问题
-6.1用户服务层接口实现
--6.1.2随堂测试
-6.2用户列表和编辑控制器实现
--6.2.2随堂测试
-6.3用户存储和删除控制器实现
-6.4用户添加、编辑界面实现
-6.5用户管理添加用户调试
-7.1用户查询模板实现
--7.1.2随堂测试
-7.2用户信息编辑的实现
-7.3单个用户删除实现
-7.4多个用户删除实现
-8.1用户列表分页基本实现
-8.2用户列表查询结果分页实现
-8.3通用日期处理
-8.4整型日期处理
--8.4.2随堂测试
-8.5枚举数据的应用
-9.1登录逻辑实现
--9.1.2随堂测试
-9.2登录界面及流程调试
--9.2.2随堂测试
-9.3管理主界面实现
--9.3.2随堂测试
-9.4授权验证拦截器实现
--9.4.2随堂测试
-9.5拦截器调试
-10.1分类接口实现
-10.2分类添加、编辑实现
-10.3分类树结构实现
-10.4分类删除实现
--10.4.2随堂测试
-11.1内容实体定义
-11.2相关接口定义
-11.3服务接口实现
-11.4内容添加、编辑模板实现
-11.5内容添加、编辑控制器实现
-11.6内容检索页面实现
-11.7内容分类树实现
-12.1修改UEditor相关问题
-12.2整合UEditor到内容编辑界面
-12.3UEditor图片对话框应用
-12.4文件上传问题处理
-13.1网站配置相关类实现
-13.2网站配置界面模板实现
-13.3网站配置调试
-14.1网站首页布局实现
-14.2菜单Vue组件实现
--14.2.2随堂测试
-14.3幻灯片Vue组件实现
-14.4滚动Vue组件实现
--14.4.2随堂测试
-14.5滚动接口实现
-14.6滚动接口调试
-14.7幻灯片接口实现
-15.1首页区域实现
-15.2首页内容脚本实现
-15.3首页完善
-15.4Vue组件放入单文件
-15.5详细页面实现
-16.1网站测试介绍
-16.2功能测试
-16.3打包发布
-16.4部署运行
--16.4.2随堂测试
