TikLab - 博客

针对 IntelliJ IDEA 环境推出 PostIn 插件，版本号1.0.1， PostIn 插件是一个针对 IntelliJ IDEA 环境的工具，集成到 IDEA 侧面板中，便于快速访问，帮助开发人员高效地管理API定义。插件可自动生成 API 文档并一键同步到 PostIn 的项目中。

本节将详细介绍 PostIn 插件下载、安装。

方式1：在 IntelliJ IDEA 中安装 PostIn 插件。打开 IDEA 设置，进入 Plugins（插件）页面，搜索 “PostIn” 并安装 “PostIn” 插件。

方式2：在 Jetbrains Marketplace 中下载后通过本地安装

，打开 IDEA 设置，进入 Plugins（插件）页面，点击Installed右侧的设置按钮，选择"install plugin from disk... "，从磁盘安装插件。

插件仅支持 IntelliJ IDEA 2024.1.7 版本。

安装结束后，在idea右侧侧边栏显示PostIn。

本节将详细介绍 PostIn 插件配置。

进入插件后，显示扫描接口， 上报接口，设置三个按钮。

配置PostIn插件，点击“设置”按钮，进入PostIn插件的配置。

需要配置PostIn服务的URL（注意配置的URL尾部不需要带"/"），以及上报接口的所属空间ID，上报接口的所属空间ID可以在PostIn空间详情。

至此，PostIn上报接口的IDEA插件已全部下载、安装、配置结束。

本节将详细介绍怎么使用PostIn插件上报接口，生成详细的接口文档。

首先需要在接口文件controller 中添加注释，包含接口协议、导入接口文件夹名称、接口地址。

● @pi.protocol：定义了接口的协议。

● @pi.groupName：定义了接口的文件夹名称。

● @pi.path：定义了该接口的基本 URL 路径。

其次，需要在接口前添加接口详细信息的注释，包含接口名称、接口详细URL、请求方式、请求类型、请求参数。通过请求类型的不同，可以分为两种。

● @pi.name：定义了接口的名称。

● @pi.url：和@pi.path共同组成了接口的完整路径，举例接口的完整路径：/workspaceFollow/createWorkspaceFollow

● @pi.methodType：定义了接口请求方式。

● @pi.request-type：定义了接口请求类型。

● @pi.url：和@pi.path共同组成了接口的完整路径，举例接口的完整路径：/workspaceFollow/deleteWorkspaceFollow

注释添加完成后，在PostIn插件点击“扫描接口”按钮，扫描当前项目所有接口。

扫描出接口后，用户可单选、多选或全选接口后提交上报。例如，接口总共有7个，按Ctrl选择其中3个，点击“上传接口”按钮，系统弹出”确认上传接口“二次确认弹窗。

点击“是”，选择的接口上传到PostIn系统。

当接口进行更新之后，还可以利用PostIn插件对接口进行更新。

接口成功上传PostIn后，对接口信息进行修改，只要接口路径（即@pi.path和@pi.url组成的路径）未进行修改，再次上传接口，会对当前接口进行更新。

接口路径（即@pi.path和@pi.url组成的路径）修改之后，再次上传接口，接口会按照新接口进行添加。

上报成功之后，可以在PostIn和 IntelliJ IDEA 环境信息对比。

下图为请求为字段，上报PostIn前后信息对比。

请检查配置的PostIn服务器URL是否正确，注意地址尾部不需要带"/"

PostIn V1.0.8版本发布，IDEA 插件支持一键扫描上报，让接口定义不再繁琐

在接口开发中，团队常常面临接口频繁变更和文档维护困难的问题。主流工具如 Postman 和 Swagger 虽能部分解决这些问题，但仍存在局限性。推荐一款开源免费的 API 管理工具 - Postin ，提供 API 设计、调试、文档生成和 MOCK 数据模拟等一站式解决方案，有效简化了开发流程，提升团队协作效率。

Postin 提供了一系列功能，包括空间管理、接口调试、接口管理和分享管理等，帮助团队高效管理和调试 API 接口，提升协作效率。

空间是 Postin 中最高级别的项目管理单元，用于帮助团队高效地组织和管理 API 资源。它作为一个独立的容器，可以容纳项目的所有 API 接口、文档、测试等资源。

    帮助用户创建和管理不同的项目空间，方便团队根据项目需求组织 API 接口、文档及相关资源，确保项目资源的高效分类和管理。

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

     提供对可复用数据模型的定义和管理，支持在多个 API 设计和调试过程中使用，确保数据的一致性和准确性。

     提供项目进展和接口使用情况的跟踪，便于数据分析和优化决策。

     便于项目成员的角色和权限分配，确保高效协作。

     自定义项目权限设置，控制成员的操作权限，保障项目安全。

Postin 提供全面的接口管理功能，包括设计、调试、文档生成和Mock等功能，支持 HTTP 和 WebSocket 协议，帮助开发者高效管理和测试 API 接口。

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

HTTP 协议设计涵盖了基础信息、请求参数和响应结果的设计

WebSocket 协议设计涵盖了基础信息、请求参数的设计

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

接口调试功能，基于接口设计自动生成数据，支持 HTTP 和 WebSocket 协议，帮助开发者快速验证和调试 API 接口

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

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

   用于管理分享后的接口文档，方便团队成员和外部开发者快速获取所需信息，促进协作。

Postin 的优势包括简洁的界面，私有部署一键安装，开源免费，支持多版本和多终端使用，保障数据安全和可靠性，具备强大的系统集成功能，满足不同开发团队的需求

界面简洁，上手简单，支持一键式安装配置。

     直观的界面设计，结构清晰，让用户可以快速找到所需的功能模块。

     私有部署支持一键安装，安装后即刻可用，无需额外配置。

提供多层级权限控制、日志审计和备份与恢复功能，确保数据安全和操作透明，防止未经授权的访问和数据丢失。

     通过应用级、系统级和项目级权限管理，确保不同角色和成员在不同层次上获得恰当的访问权限，从而保障项目的安全性。

      支持导入Postman、Swagger 和 OpenAPI 接口文档，实现与主流工具的无缝集成，简化接口管理流程。

      集成到 TikLab 全家桶生态中的 TestHubo 产品，实现测试与接口管理的无缝协作。

支持不同版本的部署，可在多个平台和设备上使用，确保灵活性和兼容性，满足多样化的开发需求。

了解更多关于 Postin 的信息，请访问以下链接：