Apipost参数描述的填写和参数描述库的使用

请求参数的描述填写对于header、query以及form-data和urlencode的body参数,我们在如下地方填写参数描述:
图片
如图中所示,对于一个填写过的参数,我们可以在新建接口可以通过点击参数描述后面的♦️方块标志快速导入描述,不用重复打字。 对于raw类型的body参数,我们可以通过点击“提取字段和描述”来针对参数进行描述的填写:对于已经填写过的参数,Apipost会自动匹配描述,不用重复填写。响应参数的描述填写很多新手困惑为什么Apipost分享的文档没有成功响应示例和错误响应示例,那是因为Apipost不会把发送后的实时响应的数据作为响应示例。您需要手动的将实时响应结果导入或者复制到对应的成功响应示例和错误响应示例。
图片
字段描述的填写跟raw类型的body参数,我们可以通过点击“提取字段和描述”来针对参数进行描述的填写。同样,对于已经填写过的参数,Apipost会自动匹配描述,不用重复填写。参数描述库的使用填写参数描述是我们最烦恼的一件事情,尤其对于很多接口来说,往往具有大量相同名称、相同意义的参数,假如每次都需要手动录入,将会是一件非常耗时、低效的事情。我们可以通过参数描述库解决这个问题。
图片
通过自定义参数描述库,我们可以将本项目用到的大量参数进行预注释:
图片
我们也可以通过导入参数描述功能,将数据库定义的字段注释快速导入到Apipost的参数描述库中。

我不是大神,helloworld!

1 声望
0 粉丝
0 条评论
推荐阅读
想快速入门性能测试?试试RunnerGo!
当前性能测试已经是一名软件测试工程师必须要了解、甚至熟练使用的一项技能。在工作时可能每次发版都要跑一遍性能,跑一遍自动化。性能测试入门容易,深入则需要太多的知识量,今天这篇文章给大家带来:怎么入门...

大雨治水

从零搭建 Node.js 企业级 Web 服务器(十五):总结与展望
总结截止到本章 “从零搭建 Node.js 企业级 Web 服务器” 主题共计 16 章内容就更新完毕了,回顾第零章曾写道:搭建一个 Node.js 企业级 Web 服务器并非难事,只是必须做好几个关键事项这几件必须做好的关键事项就...

乌柏木75阅读 7k评论 16

从零搭建 Node.js 企业级 Web 服务器(一):接口与分层
分层规范从本章起,正式进入企业级 Web 服务器核心内容。通常,一块完整的业务逻辑是由视图层、控制层、服务层、模型层共同定义与实现的,如下图:从上至下,抽象层次逐渐加深。从下至上,业务细节逐渐清晰。视图...

乌柏木45阅读 8.4k评论 6

从零搭建 Node.js 企业级 Web 服务器(二):校验
校验就是对输入条件的约束,避免无效的输入引起异常。Web 系统的用户输入主要为编辑与提交各类表单,一方面校验要做在编辑表单字段与提交的时候,另一方面接收表单的接口也要做足校验行为,通过前后端共同控制输...

乌柏木35阅读 6.6k评论 10

从零搭建 Node.js 企业级 Web 服务器(五):数据库访问
回顾 从零搭建 Node.js 企业级 Web 服务器(一):接口与分层,一块完整的业务逻辑是由视图层、控制层、服务层、模型层共同定义与实现的,控制层与服务层实现了业务处理过程,模型层定义了业务实体并以 对象-关系...

乌柏木34阅读 5k评论 9

一文搞懂秒杀系统,欢迎参与开源,提交PR,提高竞争力。早日上岸,升职加薪。
前言秒杀和高并发是面试的高频考点,也是我们做电商项目必知必会的场景。欢迎大家参与我们的开源项目,提交PR,提高竞争力。早日上岸,升职加薪。知识点详解秒杀系统架构图秒杀流程图秒杀系统设计这篇文章一万多...

王中阳Go32阅读 2.4k评论 1

封面图
从零搭建 Node.js 企业级 Web 服务器(十三):断点调试与性能分析
Node.js 官方提供了断点调试机制,出于安全性考虑默认为关闭状态,可以通过 node 参数 --inspect 或 --inspect-brk 开启,配合 IDE 能够非常方便地调试代码,本章就上一章已完成的项目 licg9999/nodejs-server-ex...

乌柏木31阅读 4.1k评论 9

我不是大神,helloworld!

1 声望
0 粉丝
宣传栏