JavaWeb前端/后端开发规范——接口文档概述及YApi平台的使用

前言:

整理下笔记,打好基础,daydayup!!!

接口文档

什么是接口文档?

目前主流的开发模式为前后端分离式开发,为了方便前后端的对接,就需要使用接口文件进行统一规范。

接口文档记载什么信息?

1,基本信息:请求路径,请求方式,接口描述

2,参数信息:参数名,参数类型,参数样例等

3,响应数据:相应数据的格式,相应数据的样例等

示例如下:

(图片来源:黑马程序员)

接口文档的创建

接口文档创建有很多方法,但使用YApi平台可以方便高效地进行创建

YApi

YApi是高效,易用的api管理平台。主要包括两个功能:1,API接口管理;2,Mock服务(模拟真实接口,生成接口的模拟测试数据,方便前端测试。即使后端没有完成,前端也可以通过模拟的接口进行测试)

YApi的使用

YApi的使用主要有三个步骤:1,添加项目;2,添加分类;3,添加接口

1,添加项目

进入界面后

随后在项目中,点击添加分类

随后在添加的分类中,点击"+"进行添加接口。

随后填写希望实现的功能与路径

提交后,在编辑里进行设置

随后进行json数据的设定,示例如下:

输入完成后,可以再一次完善下信息,最后点击最下方的保存

随后点击高级Mock,然后点击添加期望

随后在期望中修改json数据,然后点击确认

随后可以在预览中查看该测试内容

最后使用Axios中进行下测试:可以在控制台中成功获取数据

Axios相关可以看这篇:Web前端开发------Ajax,Axios概述及在Vue框架中的使用

整理结束,撒花!!!

相关推荐
h_and_g2 天前
swagger的接口文档导入到yapi上
yapi
youqingy1 个月前
酒店旅游API服务汇总
java·人工智能·后端·python·yapi·旅游
007php0071 个月前
探索骑手账户业务架构的设计与实践
java·大数据·经验分享·redis·笔记·git·功能测试·gpt·测试工具·mysql·其他·nginx·安全·百度·docker·微信·chatgpt·架构·golang·系统架构·单元测试·centos·github·yapi·测试用例·php·集成测试·postman·文心一言·课程设计·ai编程·微信公众平台·测试覆盖率·facebook·oneapi·twitter·composer·paddle·新浪微博·segmentfault·微信开放平台
惟长堤一痕1 个月前
苍穹外卖笔记-02-借助小乌龟创建gitee仓库,apifox代替YApi,Swagger
java·笔记·gitee·yapi
007php0071 个月前
《探索网络七层模型:构建高效通信架构的关键》
java·网络·经验分享·笔记·git·科技·gpt·测试工具·jmeter·其他·nginx·百度·docker·微信·chatgpt·架构·golang·系统架构·centos·aigc·yapi·测试用例·php·负载均衡·postman·文心一言·课程设计·ai编程·laravel·微信公众平台·facebook·oneapi·twitter·composer·agi·paddle·新浪微博·segmentfault·微信开放平台
nsa652232 个月前
YApi的在IDEA中的使用
yapi
007php0073 个月前
探索口腔系统功能架构的演变与未来
java·经验分享·redis·笔记·git·vscode·python·gpt·学习·selenium·jmeter·程序人生·百度·docker·微信·chatgpt·架构·golang·系统架构·单元测试·aigc·yapi·测试用例·php·postman·文心一言·sass·ai编程·微信公众平台·ai写作·facebook·composer·agi·jira·新浪微博·微信开放平台
007php0073 个月前
探索未来外贸电商系统的创新架构
java·服务器·经验分享·redis·笔记·git·python·功能测试·gpt·selenium·测试工具·程序人生·nginx·ajax·docker·微信·chatgpt·架构·golang·系统架构·单元测试·gitlab·aigc·yapi·测试用例·php·音视频·负载均衡·压力测试·postman·文心一言·sass·课程设计·ai编程·laravel·微信公众平台·模块测试·facebook·composer·agi·jira·新浪微博·微信开放平台
编程浩3 个月前
前后端分离开发【Yapi平台】【Swagger注解自动生成接口文档平台】
yapi