项目

接口调试

接口管理

高级功能

系统设置

使用指南

PostIn

PostIn - 文档

​在我们的日常研发过程中，为了减少前端、后端、测试沟通成本，通常会使用一些接口管理工具PostMan。PostMan是一款广泛使用的‌API开发与测试工具，‌主要用于模拟HTTP请求、调试接口，不适合高并发或压力测试场景，对特殊协议（如WebSocket）支持有限，另外高级功能（如团队协作）需购买商业版，对预算有限的团队不友好‌。
今天给大家推荐一款国产开源免费、简洁易用的接口管理工具-PostIn。

PostIn包含项目管理、接口调试、接口设计、MOCK数据、接口用例、性能测试、测试计划等模块，支持常见的HTTP协议、websocket协议等，界面操作简洁明了、开源免费。

支持http和websocket协议，支持PostMan、Swagger、OpenApi协议接口导入，包含接口调试、接口设计、MOCK数据功能。

提供接口单元用例、场景用例、性能用例，以及分布式运行性能用例功能。

支持批量关联用例进行执行，支持定时触发、以及CICD方式（Arbess）触发测试计划。

私有部署支持一键安装，安装后即刻可用，无需额外配置。
直观的界面设计，结构清晰，让用户可以快速找到所需的功能模块。

免费开放源代码，支持社区协作和共享，推动项目不断发展和优化。

以下以linux Ubuntu安装为例，其它环境安装方式见官网文档，以下示例安装使用默认内嵌agent，若需配置性能测试分布式运行则需要独立安装外部agent，具体可参见官方文档。

启动后，通过 http://ip:9300 访问，默认使用admin/123456登录。系统默认支持本地账号登录，满足基础登录需求。若需要使用企业微信、钉钉或 LDAP 等高级登录方式，可参阅PostIn文档获取相关配置说明。​

有兴趣的开发者朋友可以去Tiklab官网体验演示DEMO或下载安装使用，使用过程当中有什么好的建议或意见也欢迎加入社区-技术交流群反馈：）
体验地址：https://demo.tiklab.net/postin
下载地址：https://download.tiklab.net/postin

​

关于PostIn

社区版与企业版的区别

加入我们的技术交流群，参与互动交流，提升自我

联系我们

产品介绍

PostIn支持用户自定义端口、数据库、统一登录等配置，用户可以根据自己的需求来更改，只需要编辑默认文件

application.yaml即可。PostIn的配置文件位置：默认在/opt/tiklab-postin/conf 目录下。

允许用户自定义应用的启动端口，以便在特定网络环境下避免端口冲突或满足其他配置需求。

支持自定义数据库连接方式，用户可以选择使用内嵌数据库或指定外部数据库地址。根据需求配置数据库连接。

支持用户自定义数据存放目录的位置，帮助用户根据需要选择存储路径。

dcs 是缓存配置，只能修改端口。

的用户，部门等，这样配置可以让一个用户同时使用多个应用。需要安装Soular，具体安装详见

程序安装结束后，可以在系统执行如下。

使用 postinctl -v 或者 postinctl version 查看当前安装版本。

Linux 安装配置

Docker镜像启动完毕之后，如需要将Docker镜像中的数据目录挂载到主机，需要执行如下命令

挂载完毕后，启动系统，系统会读取设置的主机数据目录和配置文件。

启动完成后，这样你就可以通过 http://localhost:9300 访问 PostIn 界面了，初始化账号为：admin ,密码为：123456，首次登录需要更改密码。

Docker 安装配置

允许自定义端口、数据存放目录、数据库连接、数据库备份策略和统一登录设置，以满足特定个性化需求。yaml文件默认位置：

Windows 安装配置

允许自定义端口、数据存放目录、数据库连接、数据库备份策略和统一登录设置，以满足特定个性化需求。yaml文件默认位置：默认在app下的Contents --> conf目录下

MacOS 安装配置

安装配置

PostIn安装结束并登录后，需要创建项目来对接口分项目进行管理，项目是 Postin 中最高级别的项目管理单元，用于帮助团队高效地组织和管理 API 资源。它作为一个独立的容器，可以容纳项目的所有 API 接口、文档、测试等资源。

通过创建项目可以帮助开发团队有效地集中管理项目相关的接口资源，使得团队成员能够快速查找和使用所需的 API 信息。点击

，可添加公共或者私密的项目，其中公共项目所有用户可浏览，私密项目仅选择的用户可浏览。

在项目页面，点击右上角“添加项目”按钮，弹出添加项目页面。

”，或者“我创建的”找到创建的

成员之前，需要添加系统用户，依次点击

，展示用户列表。系统内置管理员用户，无法删除。

点击“添加用户”，展现添加用户弹窗。

添加账号成功之后，可以对账号进行编辑、修改密码、重置密码、删除。

系统用户添加完成之后，可以对

如果用户在创建项目未选成员，那么项目默认有创建人和admin两个成员。点击添加用户，添加的成员列表从系统用户列表获取。

勾选添加用户，点击确定即可成功添加项目成员。

添加项目成员后，对成员修改角色，点击项目详情→设置→权限，可浏览到内置角色。

在项目详情→设置→成员，点击“角色修改”，对成员角色进行修改。成员角色可多选。

创建成功之后，默认进入该项目的项目详情，在项目详情，对项目下所有接口进行管理。

详情—接口管理，将接口记录到项目列表中，生成接口文档，选择环境对接口进行调试。

项目详情—接口调试，不记录接口信息，对接口进行简单调试。

项目详情—接口用例，接口用例（单元用例、场景用例、性能用例）列表，点击用例名称展开用例详情。

项目详情—测试计划，关联接口用例，系统化地对接口进行测试。

创建项目

Postin 提供快速便捷的接口调试功能，与接口管理中的接口区别在于需要手动输入参数，用于临时测试不需要管理的接口。支持 HTTP 和 WebSocket 协议，帮助开发者验证 API 接口的功能和行为，确保接口按预期工作。

WebSocket协议在接口调试页面区别。

‌HTTP协议客户端发起请求后，服务器返回响应即断开连接，每次通信需重新建立连接。在接口调试页面选择HTTP协议，界面显示HTTP协议接口调试需要的项目。

接口调试页面，点击tabs页右侧的“+”号，添加一个新的接口调试tabs。

选择“HTTP”协议，显示请求方式下拉框，输入需要测试接口的请求方式，支持的请求方式包含GET、POST、HEAD、PUT、DELETE、PATCH。

在地址栏中输入需要测试的接口地址，包括主机和路径等信息。

在相应的输入框或表单中输入需要传递给接口的请求参数。这些参数可以包括查询参数、请求体参数、请求头等，根据接口的需求进行输入。

点击界面上的发送按钮，将测试请求发送给目标接口。系统将会使用输入的请求地址和参数发送请求，并等待接收到服务器的响应。

在接收到服务器的响应后，系统会将响应结果显示在界面上，包括响应状态码、响应体内容等信息。用户可以在界面上直接查看测试结果，以便进行验证和调试。

WebSocket‌协议连接建立后客户端与服务器可双向实时传输数据，无需重复握手。在接口调试页面选择WebSocket协议，界面显示WebSocket协议接口调试需要的项目。

要与服务器进行通信，你首先需要建立一个 WebSocket 连接。只需点击“连接”按钮即可。

在请求栏输入需要传递给接口的请求参数。这些参数可以包括查询参数、请求体参数、请求头。

在接收到服务器的响应后，系统会将响应报文显示在界面上。用户可以在界面上直接查看测试结果，以便进行验证和调试。

在接口请求发送‌之前‌执行，主要用于准备测试数据、动态修改请求参数或设置环境变量。

例如，使用前置脚本设置请求头参数ticket。

或者还可以设置一些其他前置脚本。例如生成随机用户ID和当前日期，并将生成的数据写入请求体表单中 。

在接口请求发送‌之后‌执行，主要用于解析响应数据、断言校验、清理测试数据或传递参数给后续请求。

例如登录接口，取响应体json中data.ticket，将动态值存储至环境变量ticket中，后续通过{{ticket}}引用。

‌支持可视化断言，在接口调试点击断言，显示需要输入断言的来源（状态码、响应体、响应头）、属性名称、比较符、参数值。添加完成之后，调试接口在接口响应栏下断言tab，显示断言是否成功。

包括验证响应体中是否‌包含特定字符串‌‌、‌JSON字段值是否匹配预期‌‌，或直接对比整个响应体与预设字符串是否完全一致‌。

例如，如上图的断言显示执行成功。

接口每一次调试都会记录在左侧接口调试历史列表，点击调试历史列表，右侧显示调试时设置的参数。

点击调试历史右侧的删除按钮，可以对调试历史进行删除。点击接口调试列表右上角“扫把”按钮，清空调试历史列表。

点击右侧导航栏的“接口”进入接口页面，接口以目录的形式进行分组。添加接口之前需要先添加目录，点击列表右上角的“+”，添加接口目录。

目录名称必填，目录添加完成之后，可以在目录下添加接口，或者添加子目录。

在目录右侧点击“+”添加接口，包含添加HTTP或者WebSocket协议接口。选择添加HTTP协议接口，输入接口的基本信息接口名称、请求类型、接口路径，点击“提交”，成功添加接口。

在目录右侧点击“+”，选择添加WebSocket协议接口，输入接口的基本信息接口名称、请求类型、接口路径，点击“提交”，成功添加接口。

在接口列表，可以对接口名称进行模糊查询。

点击目录的接口右侧“…”，对接口进行编辑、删除。

除了手动添加接口这个方式，PostIn还支持通过Postman/OpenAPI V3/Swagger V2的json格式导入。在目录右侧点击“+”，选择导入。

选择导入json的类型，上传json文件。上传json文件的时候会校验相关格式。

上传符合格式的json文件，点击提交，成功导入接口。

接口设计通过设置基础信息、请求和输出结果的参数，来构造当前接口的具体使用方式。支持多种协议，包括 HTTP协议和 WebSocket协议，灵活适应不同应用需求。

支持管理多个环境配置（如开发、测试、生产），便于在不同环境中测试和验证 API。

点击添加环境，需要输入环境名称、环境地址。注意：环境地址尾部不需要带“/”

在环境页面，还可以对环境进行编辑、删除。

环境配置结束后，在接口测试页面，点击右上角环境下拉框，选择测试接口所用的环境。

环境设置结束后，在测试页面，点击环境下拉框，弹出环境选择，点击需要测试的环境，点击发送，进行接口测试。

选择环境之后，点击“发送”，对接口进行测试。

接口文档基于接口设计自动生成，确保接口信息实时更新，便于团队随时查阅和对接，支持 HTTP 和 WebSocket 协议，方便共享给其他开发者或团队成员。

在接口页面选择需要分享的接口，点击右上角分享按钮。

接口分享支持公开分享和密码分享两种方式。

Postin 提供内置的 HTTP 协议 MOCK 数据生成功能，支持前端在后端未完成时进行独立开发和测试，减少依赖，提升开发效率。

在接口点击Mock，进入Mock页面，显示内置Mock环境地址。

点击页面右上角“添加MOCK”，添加MOCK，添加MOCK字段属性说明：

添加MOCK后，MOCK默认为启用状态，可以在MOCK列表对MOCK进行启用\禁用。

点击添加MOCK，输入MOCK的名称后，点击提交，添加一条MOCK虚拟响应。

配置MOCK虚拟请求后，使用MOCK环境，点击测试，如果请求和MOCK一致，则接口响应也会和MOCK设置的一致。

，选择MOCK环境，当请求参数符合

MOCK“查询成功”的请求参数，则显示响应code:200，响应体：{"msg": "登录成功"}

MOCK“查询失败”的请求参数，则显示响应code:201，响应体：{"msg": "密码输入错误"}

MOCK默认为启用状态，使用MOCK环境，当请求参数符合MOCK设置的请求参数，接口会根据MOCK设置给出响应。

此时禁用MOCK，再次使用符合MOCK设置的请求参数，此时接口返回失败。

点击MOCK右侧的编辑按钮，可对MOCK的基本信息进行编辑。

 点击MOCK右侧的删除按钮，可删除对应MOCK。注意：删除的MOCK无法恢复，请谨慎操作。

MOCK数据

本文将介绍如何添加接口单元用例、场景用例、性能用例，以及添加测试计划，对用例和计划进行测试。

针对单个接口的输入输出进行验证，包括正常数据返回、异常数据处理、边界值校验等，确保接口基础逻辑的正确性‌。


通过组合多个接口形成业务场景（如用户注册-登录-下单），验证系统端到端的业务流程逻辑‌。


通过模拟高并发请求，测试接口的吞吐率、响应时间、资源消耗等指标，验证系统性能瓶颈‌。

接口单元用例支持通过接口定义保存为用例、手动添加两种方式。

在接口管理，点击调试tab，发送调试后，可将当前调试参数保存为用例。

输入测试用例名称，点击提交，即可成功保存用例。
测试用例保存完毕之后，在接口的用例tab可查看当前接口产生的接口单元用例。

除了在接口管理利用接口调试内容生成接口单元，还可以在接口测试页面手动添加接口，在接口测试页面，点击左侧上方的“+”→添加用例。

输入接口用例的基本信息进行添加。

添加完成后，点击用例名称进入接口用例详细内容进行编辑。

接口场景用例用于构建复杂的接口测试场景，模拟真实业务流程。测试用例采用先新增后编辑详细信息的模式，点击“+”→添加场景。
成功新增接口场景用例之后，点击用例名称，编辑用例详细信息。点击基本信息右侧的更多按钮，可编辑用例详细基本信息。

在接口场景用例，需要在测试步骤设计接口场景，例如取到的变量是admin，则执行登录，否则执行其他接口。测试步骤添加if判断，在接口场景用例，点击添加步骤→if判断。

接口场景用例测试步骤添加接口单元用例，在接口场景用例，点击添加步骤→关联用例。

集成接口性能测试工具，支持对API进行高并发和负载测试。点击“+”→添加接口性能。
添加性能用例后，点击性能用例名称，进入用例详情，性能用例可关联接口单元用例或者接口场景用例来进行压测。

关联用例之后，进行接口性能策略配置。支持按照次数或者时间对接口进行压测。


维护接口用例后，点击接口用例名称，进入接口详情编辑，在接口用例详情也可以对接口进行测试。用例测试使用的环境和接口管理一致。用例测试前需要选择用例测试环境，选择环境后点击测试按钮。

也可以点击“历史”按钮，查看用例调试历史。

可以对接口单元用例、接口场景用例添加测试计划，在测试计划中集中运行，也可以实现给Arbess进行调用，在CICD前自动执行测试计划。

在接口测试页面点击测试计划→添加计划。添加测试计划。

新增测试计划成功之后，在测试计划列表可以看到新增的测试计划，也可以通过测试计划名称进行查询。
添加自动化测试计划后，点击测试计划名称，进入测试计划详细，点击关联用例，可以将用例库中的接口用例（接口单元、接口场景），批量的添加到测试计划中。

绑定用例后，可以使用用例名称（模糊查询）来进行筛选。点击关联的用例名称，可以查看测试用例的基本信息。

点击测试用例右侧“…”显示删除按钮，这里的删除只是删除用例和测试计划的关联关系，不是删除用例。

在测试计划选择环境，点击测试，执行测试计划所有用例。弹窗显示测试结果。测试结果包含总体测试结果、执行用例数量、通过/失败数量、通过率/失败率、耗时、以及每个用例执行情况。

在测试历史可以点击测试的序号来查看测试结果。

测试结果包含总体测试结果、执行用例数量、通过/失败数量、通过率/失败率、耗时、以及每个用例执行情况。

测试计划执行完毕之后，用户可选择生成测试报告，系统会根据选择时间范围生成测试报告。

点击测试报告名称，查看测试报告。

测试计划还可以通过定时任务的方式执行，分为单次触发、循环触发。

单次触发，测试计划只会执行单次，选择执行日期和执行时间，测试计划按照设置日期执行。

设置单次触发，任务状态为运行中，单次任务执行完毕之后，任务状态更改为已触发。

循环触发定时任务，需要设置循环触发时间间隔，如下图测试计划会每600分钟执行一次。

接口用例

快速入门

查询项目

编辑项目

删除项目

项目信息

环境设置

模型

成员

权限

数据库连接

项目设置

HTTP协议

WebSocket协议

查询目录

创建目录

编辑目录

删除目录

查询接口

创建接口

删除接口

HTTP

Websocket

查看接口

postin-doclet

用户

消息

集成与开放

安全

最佳实践

社区版本和企业版本区别可参考官网地址：https://tiklab.net/price/arbess

也可以下滑查看详细的版本方案对比：

社区版本和企业版本区别

在官网登录个人账号，点击头像进入个人中心。

选择自己需要的软件，提交订单。

付款方式支持微信、支付宝以及对公转账。

如何购买企业版？

首先需要下载社区版本，在社区版本导入licence升级到企业版本，企业版本采用一次付费，不限人终身使用的方式。

Arbess社区版需要升级企业版，首先先需要确定当前版本，在

，可以找到当前的版本类型，点击“企业版特性”可以浏览到社区版和企业版功能对比。

如需要升级企业版，点击右侧订阅按钮。

点击订阅按钮，页面打开官网，用户需要经过登录后，进入订阅管理，选Arbess点击订阅。

支付完成后，在已订阅会显示订阅的产品，点击订阅的产品右侧的“licence”。

在弹出的窗口填入Arbess服务器的MAC地址，下载licence。

下载完成，回到私有化部署的版本，在

数据中心版本下载需要联系售前咨询客服，我们在收到您的需求会及时和您联系。

社区版如何升级企业版和数据中心版？

产品购买完成后，可以在购买账号的发票管理中，选择申请开票。

申请开票列表会显示已购的软件，勾选已购软件进行开票。

已开票和开票中的信息都可以在发票管理进行查询。

开完票，在已开票列表显示，查看发票详情可下载发票。