核心内容摘要
三姐妹的生日愿望，是家人最美的牵挂_2
PostIn是一款开源免费的接口管理工具包含项目管理、接口调试、接口文档设计、MOCK、接口测试、测试计划等模块支持免费私有化部署一键安装零配置支持免登陆本地接口调试。
本文将介绍如何对接口进行管理。
添加接口项目、成员创建成功之后进入项目详情显示接口管理页面接口以目录的形式进行分组。
添加接口之前需要先添加目录点击列表右上角的“”添加接口目录。
添加目录目录名称必填目录添加完成之后可以在目录下添加接口或者添加子目录。
1 HTTP接口在目录右侧点击“”添加接口包含添加HTTP或者WebSocket协议接口。
选择添加HTTP输入接口的基本信息接口名称、请求类型、接口路径点击“提交”成功添加接口。
添加HTTP接口属性是否必填描述接口名称必填为接口设置名称简单描述一下接口目的方便后期识别管理。
请求方式必填HTTP接口请求方式支持GET、POST、HEAD、PUT、DELETE、PATCH。
接口路径必填具体接口在服务器上的位置。
描述选填提供接口简短描述方便后期团队成员快速了解接口。
2 WebSocket接口在目录右侧点击“”选择添加WebSocket协议接口输入接口的基本信息接口名称、请求类型、接口路径点击“提交”成功添加接口。
添加WebSocket接口属性是否必填描述接口名称必填为接口设置名称简单描述一下接口目的方便后期识别管理。
接口路径必填具体接口在服务器上的位置。
描述选填提供接口简短描述方便后期团队成员快速了解接口。
在接口列表可以对接口名称进行模糊查询。
接口查询也点击目录的接口右侧“…”对接口进行编辑、删除。
编辑、删除接口
导入接口除了手动添加接口这个方式PostIn还支持通过Postman/OpenAPI V3/Swagger V2的json格式导入。
在目录右侧点击“”选择导入。
导入接口选择导入json的类型上传json文件。
上传json文件的时候会校验相关格式。
不符合格式提醒上传符合格式的json文件点击提交成功导入接口。
设计接口接口设计通过设置基础信息、请求和输出结果的参数来构造当前接口的具体使用方式。
支持多种协议包括 HTTP协议和 WebSocket协议灵活适应不同应用需求。
HTTP 协议设计涵盖了基础信息、请求参数和响应结果的设计。
WebSocket 协议设计涵盖了基础信息、请求参数的设计。
接口设计请求参数属性描述Header位于HTTP请求的头部用于传递元数据。
Query出现在URL问号后对资源进行筛选、排序或分页。
Path嵌入在URL路径中明确标识资源的唯一路径。
Body位于HTTP请求的正文用于传递实际数据。
其中Body类型及其用途如下。
属性描述none不设置请求Body。
form-data上传文件或同时提交文本和文件。
x-www-form-urlencoded提交简单的键值对表单数据适用于传统 HTML 表单提交。
jsonRaw 的子集严格遵循JSON语法键值对、双引号、嵌套结构等用于结构化数据传输。
raw原始数据格式支持任意文本内容如JSON、XML、纯文本等。
测试接口
1 设置环境Postin 测试调试接口支持管理多个环境配置如开发、测试、生产便于在不同环境中测试和验证 API。
在测试API接口之前点击基础数据→设置→环境进入环境配置。
环境配置点击添加环境需要输入环境名称、环境地址。
注意环境地址尾部不需要带“/”属性是否必填描述环境名称必填为环境设置一个简洁明了的名称便于识别和管理。
环境地址必填接口请求的目标地址与接口路径组成接口请求的完整地址。
在环境页面可以对环境可以进行编辑、删除。
环境配置结束后在接口测试页面点击右上角环境下拉框选择测试接口所用的环境。
选择测试环境
2 测试接口环境设置结束后在测试页面点击环境下拉框弹出环境选择点击需要测试的环境点击发送进行接口测试。
接口测试
查看接口文档接口文档基于接口设计自动生成确保接口信息实时更新便于团队随时查阅和对接支持 HTTP 和 WebSocket 协议方便共享给其他开发者或团队成员。
接口文档
分享接口在接口页面选择需要分享的接口点击右上角分享按钮。
接口分享接口分享支持公开分享和密码分享两种方式。
公开分享在浏览器中打开分享界面的链接直接可以打开分享的接口。
密码查看打开分享的链接咋需要输入密码后才支持浏览接口。
支持自定义密码分享密码区分大小写。
分开分享接口打开分享窗口后复制分享链接其他用户可通过分享的链接查看接口。
查看接口支持查看分享的接口点击左侧“分享”按钮在分享页面显示分享过的接口列表。
在分享页面可以查看接口分享的链接、修改分享密码、取消分享。
分享管理有兴趣的朋友欢迎前往tiklab官网体验在线版本、或者免费下载私有化部署体验。