PostIn是一款国产开源免费的接口管理工具,工具简洁易用、开源免费。本文将指导你如何创建和管理你的第一个空间,快速入门上手。
1、创建空间
创建空间可以帮助开发团队有效地集中管理项目相关的接口资源,使得团队成员能够快速查找和使用所需的 API 信息。
点击 空间 --> 添加空间 进入
属性说明:
空间名称 | 必填 | 简明扼要的描述空间,方便团队成员识别和管理。 |
可见范围 | 必填 | 定义空间的访问权限,可限制特定成员进入。 |
成员选取 | 选填 | 添加有访问权限的成员,方便团队协作和权限管理,默认拉入管理员和当前创建人。 |
描述 | 选填 | 用于对空间的用途或包含的项目进行简要说明,帮助团队成员快速了解该空间的内容和目标。 |
2、空间查询
展示了所有已创建的空间,包括每个空间的关键信息。用户可以在此界面进行添加、筛选和管理操作,以便快速找到所需的空间并进行相应的管理。
- 最近访问
最近访问,方便用户快速定位和打开常用项目,提升使用效率。
- 空间列表
在每个空间项中显示关键信息,例如空间名称、负责人、可见范围等。
3、空间详情
允许用户轻松访问和管理已创建的空间的详细信息,便于组织和分类 API 接口及相关文档,从而提升团队的协作效率和资源管理能力。
3.1 空间概况
空间概况提供当前空间内接口的状态统计、趋势分析和最新动态,帮助团队实时监控接口运行情况,并优化项目管理。
点击 空间名称 --> 概况 进入
3.2 接口管理
PostIn提供全面的接口管理功能,包括设计、调试、文档生成和Mock等功能,支持 HTTP 和 WebSocket 协议,帮助开发者高效管理和测试 API 接口。
(1) 接口设计
接口设计通过设置基础信息、请求和输出结果的参数,来构造当前接口的具体使用方式。支持多种协议,包括 HTTP 和 WebSocket,灵活适应不同应用需求。
- HTTP协议
HTTP 协议设计涵盖了基础信息、请求参数和响应结果的设计
HTTP协议详细字段描述:
HTTP请求类型:
方法 | 描述 |
GET | 从服务器获取资源。 |
POST | 用于向服务器提交数据,通常用于创建新的资源。 |
PUT | 更新已有资源,通常是替换整个资源。 |
DELETE | 用于请求删除指定资源。 |
HEAD | 与 GET 方法类似,但服务器仅返回响应头,不返回响应体。 |
PATCH | 用于部分更新指定资源的信息。 |
- WebSocket协议
WebSocket 协议设计涵盖了基础信息、请求参数的设计
WebSocket协议详细字段描述:
(2)接口文档
接口文档基于接口设计自动生成,确保接口信息实时更新,便于团队随时查阅和对接,支持 HTTP 和 WebSocket 协议,方便共享给其他开发者或团队成员。
(3)接口调试
接口调试功能,基于接口设计自动生成数据,支持 HTTP 和 WebSocket 协议,帮助开发者快速验证和调试 API 接口
(4) MOCK模拟数据
Postin 提供内置的 HTTP 协议 MOCK 数据生成功能,支持前端在后端未完成时进行独立开发和测试,减少依赖,提升开发效率。
3.3 接口快捷调试
Postin 提供快速便捷的接口调试功能,与接口管理中的接口区别在于需要手动输入参数,用于临时测试不需要管理的接口。支持 HTTP 和 WebSocket 协议,帮助开发者验证 API 接口的功能和行为,确保接口按预期工作。
3.4 分享
用于管理分享后的接口文档,方便团队成员和外部开发者快速获取所需信息,促进协作。
4、空间设置
4.1 模型
模型提供可复用的数据定义和管理功能,确保数据一致性,并提升开发效率和团队协作。通过共享常用数据模型,减少重复工作,加快接口设计和调试进程。
4.2 环境
支持多环境配置(如开发、测试、生产),方便开发者在不同环境中灵活调试和验证 API。通过一键切换环境,减少手动配置,确保接口行为一致,提升开发和测试效率。
4.3 成员管理
支持将不同成员添加到指定的项目空间,以便统一管理项目中的相关人员。
4.4 权限说明
权限支持定义不同角色和权限的管理,确保项目成员拥有适当的访问和操作权限,支持灵活的角色分配和权限调整。
4.5 基础设置
允许用户修改空间名称、调整可见范围,以及更新空间描述,帮助团队根据实际需求配置空间设置。
点击 设置 --> 空间信息 进入
- 导出项目:
支持将项目以 HTML 或 PDF 格式导出,方便保存、分享项目文档。
5、删除空间
双重校验,删除空间操作不可恢复,请谨慎操作
6、帮助与支持
文档:
社区:
标签:精通,HTTP,入门,接口,PostIn,文档,空间,WebSocket,团队 From: https://blog.csdn.net/westforest0910/article/details/145482634