一、接口文档编写
步骤: 1、学习Markdown语法
2、编写文档公共部分
3、编写接口文档
MD语法入门:
1、# 一级标题
2、## 二级标题
3、引入图片/跳转连接:[超链接名](超链接地址 “超链接title”)
4、引用内容:```代码引用```
5、列表:无序列表 - 、+ 、*、 有序列表 1
二、轮播图接口数据获取(接口联调)
步骤:1、阅读接口文档
2、配置接口地址
3、使用axios获取数据
4、将数据设置到模型层
三、关键性名词
(一)ajax
Ajax,全称“Asynchronous JavaScript and XML”(异步JavaScript和XML),是一种用于创建快速动态网页的技术。它不是一种新的编程语言,而是一种使用现有标准(如JavaScript、XML、HTML和CSS等)的新方法,用于创建更好、更快以及交互性更强的Web应用程序。
Ajax通过在后台与服务器进行少量数据交换,实现网页的异步更新。这意味着可以在不重新加载整个网页的情况下,对网页的某部分进行更新。传统的网页(不使用Ajax)如果需要更新内容,必须重新加载整个页面,而Ajax技术则能节省网络带宽,提高页面的加载速度,从而缩短用户等待时间,改善用户体验。
Ajax的核心是XMLHttpRequest对象。这个对象允许网页在不重新加载整个页面的情况下,与服务器进行通信并获取数据。通过配置请求方式和请求地址,以及设置回调函数来处理服务器响应,开发者可以实现与服务器之间的异步数据交换。
Ajax广泛应用于各种Web应用程序中,如表单验证、动态内容加载、实时数据更新等。例如,当用户在一个网页上填写表单并提交时,Ajax可以立即将表单数据发送到服务器进行验证,而无需重新加载整个页面。如果验证失败,Ajax可以显示错误信息并允许用户立即更正;如果验证成功,则可以动态更新页面上的部分内容,如显示成功消息或加载新的数据。
(二)axios
Axios是一个基于Promise的HTTP客户端,主要用于浏览器和Node.js环境。
Axios(全称ajax–I/O–system)提供了一个简单而直观的API,使得在前端应用程序中进行HTTP通信变得更加容易。它可以发送各种类型的HTTP请求,如GET、POST、PUT、DELETE等,并支持诸如请求和响应拦截、转换数据、取消请求以及自动转换JSON数据等功能。
Axios支持Promise API,这使得它易于与async/await结合使用,从而简化了异步编程的复杂性。
Axios可以在客户端(浏览器)和服务器端(Node.js)使用,具有高度的兼容性。
Axios提供了请求和响应拦截器,允许开发者在请求被发送或响应被处理之前进行拦截和修改,这有助于实现如认证、日志记录等功能。
Axios会自动将响应数据转换为JSON格式,这简化了数据处理的流程。
Axios提供了取消请求的功能,这有助于处理如用户取消操作等场景。
Axios能够处理CORS(跨域资源共享)请求,这使得它能够在不同源之间安全地传输数据。
Axios可以方便地发送HTTP请求到后端API,获取数据并更新前端页面。
在前端表单验证通过后,Axios可以发送POST请求将表单数据提交到后端进行处理。
Axios可以用于实现如实时聊天、股票行情等实时数据更新的功能。
Axios支持文件上传和下载功能,可以通过POST请求发送文件数据,并通过GET请求下载文件。
(三)跨域
跨域,通常指的是在计算机网络中,不同域名、协议或端口之间的资源访问行为。在Web开发中,跨域问题尤为常见,特别是在前后端分离或分布式系统的架构下。
跨域的定义元素:
协议:协议是跨域判断的首要因素。如果两个资源使用的协议不同(例如,一个是HTTP,另一个是HTTPS),则它们被视为跨域。
域名:域名是跨域判断的核心要素。如果两个资源的域名不同,即使它们使用相同的协议和端口,也构成跨域。
端口:端口号也是跨域判断的一个方面。在相同域名和协议下,如果两个资源使用的端口号不同,它们也被视为跨域。
(四)Vant
Vant于2017年开源,是一套专为移动端设计的Vue组件库。通过Vant,开发者可以快速搭建出风格统一的页面,并提升开发效率。Vant提供了60+的高质量组件,涵盖了反馈、展示、导航和业务等多个方面,满足了移动端开发的多样化需求。
主要特性:
轻量级:Vant一直将轻量化作为核心开发理念,通过组件按需加载、公共模块复用、组件编译流程优化等方式,实现了组件体积的极致压缩。目前,Vant的组件平均体积仅有8.8KB,经过Uglify+Gzip压缩后更是可以减小到约1KB,非常适合移动端使用。
高质量组件:Vant提供了丰富的组件,每个组件都经过精心的设计和开发,确保了高质量的用户体验。同时,Vant还提供了完善的单元测试,确保了组件的稳定性和可靠性。
易用性:Vant提供了完善的中英文文档和示例,帮助开发者快速上手。此外,Vant还支持babel-plugin-import插件,可以优化代码体积并提高前端性能。
使用场景:Vant适用于各种移动端应用场景,如移动商城、移动办公、移动社交等。通过Vant提供的组件,开发者可以快速搭建出风格统一、功能完善的移动端应用。
使用方法:使用Vant的方法非常简单,可以通过CDN直接引入,也可以通过npm安装并使用构建工具进行打包。在使用时,可以根据需要选择按需引入或一次性引入所有组件。对于按需引入的组件,Vant会自动进行代码分割和懒加载,以提高应用的性能和用户体验。
Vant是一个功能强大、易用且轻量级的移动端Vue组件库,它提供了丰富的组件和高质量的文档支持,帮助开发者快速搭建出风格统一的移动端应用。
(五)ORM名词解释
ORM模型,全称Object-Relational Mapping(对象关系映射),是一种在面向对象的编程语言中常用的技术。
ORM模型通过在对象(通常是面向对象编程语言中的类和对象)和关系数据库之间建立映射关系,使得开发者能够以面向对象的方式来操作数据库。这种映射关系是通过元数据(metadata)描述的,元数据定义了对象属性和数据库表列之间的对应关系。
应用场景:ORM模型广泛应用于各种Web开发框架中,如Django(Python)、Laravel(PHP)、Ruby on Rails(Ruby)等。在这些框架中,ORM模型是连接业务逻辑和数据库的重要桥梁。
ORM模型是一种强大的工具,它能够帮助开发者以面向对象的方式来操作数据库,提高开发效率和代码质量。然而,在使用ORM模型时,开发者也需要注意性能、安全性和复杂性等方面的问题。
(六)接口联调
接口联调旨在确保系统中各个模块或组件之间的接口能够正确无误地协同工作,数据流和控制流能够按照设计要求顺畅进行。通过接口联调,可以验证接口的功能、性能、稳定性和安全性等方面,确保最终集成的系统能够满足项目需求和质量标准。