PostIn是一款开源免费的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 接口的功能和行为，确保接口按预期工作。

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

模型提供可复用的数据定义和管理功能，确保数据一致性，并提升开发效率和团队协作。通过共享常用数据模型，减少重复工作，加快接口设计和调试进程。

支持多环境配置（如开发、测试、生产），方便开发者在不同环境中灵活调试和验证 API。通过一键切换环境，减少手动配置，确保接口行为一致，提升开发和测试效率。

支持将不同成员添加到指定的项目空间，以便统一管理项目中的相关人员。

权限支持定义不同角色和权限的管理，确保项目成员拥有适当的访问和操作权限，支持灵活的角色分配和权限调整。

允许用户修改空间名称、调整可见范围，以及更新空间描述，帮助团队根据实际需求配置空间设置。

     支持将项目以 HTML 或 PDF 格式导出，方便保存、分享项目文档。

双重校验，删除空间操作不可恢复，请谨慎操作

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

PostIn入门指南(2) - 创建空间

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

一键智能解析：在IDEA中扫描JAVA代码，通过添加的注释自动识别接口路径、参数、返回值，无需手动整理！

全格式文档生成：秒级导出API标准文档，无缝对接PostIn平台！

动态同步更新：代码改动后，文档实时同步更新，杜绝“代码更新、文档滞后”产生的一系列问题！

自定义模板：支持团队统一配置文档样式、字段注释规范，让协作更专业！

省时省力：3秒生成100个接口文档，避免手工复制粘贴占用开发时间！

简单易用：无需配置复杂环境，安装即用，操作简单！

零误差：代码即文档，逻辑与描述100%一致，避免人为错误！

高效协作：代码与文档实时同步，解决了文档滞后代码、沟通成本高等一系列问题！

本节将详细介绍 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.param: model=io.tiklab.postin.workspace.model.WorkspaceFollow

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

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

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

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

 * @pi.param: name=id;dataType=string;value=workspaceId;desc=当前删除的id

 * @pi.param: name=id2;dataType=string;value=workspaceId2;desc=当前删除的id2

● @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 插件支持一键扫描上报，让接口定义不再繁琐

系统全面支持各种附件的上传，上传后文件可以再次下载到本地，对部分文件支持在线预览

（1）登录系统后，选择您想要存储文件的知识库，并进入该知识库的文档页面，点击添加按钮即可找到上传本地文件链接。

找到”上传本地文件“的链接并点击

（2）点击链接后，会弹出选择本地文件的窗口，找到您想要上传的文件后，双击或者选中文件后点击打开按钮，文件自动上传到系统并展示在知识库左侧。

（3）您还可以按照自己的习惯新建目录，并将文件移动至特定目录，便于进一步整理和分类文件。

（4）上传后的文件可以继续下载到本地或分享给他人。

对于未解析文件，系统提供存储和下载

sward V1.0.8版本发布，全面支持各种附件上传预览

 GitPuk是一款国产开源免费的代码管理工具，工具简洁易用，开源免费，本周GitPuk发布v1.1.1版本，新增JavaScript语言扫描、支持mysql数据库类型、添加ububtu包、代码推送规则设置、集成arbess的Cl/CD功能。

优化了仓库角色，优化了系统角色

2.点击仓库左下角的设置，打开仓库配置后点击推送设置

3.点击新建推送规则，输入对应的内容点击确定即可

2.进入后，点击左侧的Cl/CD后，打开关联流水线

3.打开后系统会跳转至系统集成，点击添加地址输入对应的内容，点击确定即可

GitPuk V1.1.1版本发布，增加JS语言扫描，集成arbess CI/CD功能

​Arbess 是一款国产开源免费的 CI/CD 工具，包含流水线管理、流水线设计、流水线执行、测试报告、统计分析等模块，支持丰富多样的任务类型，界面操作简洁明了、开源免费。本周Arbess V1.1.4 版本发布，支持Mysql数据库，Ubuntu系统，增加SSH及Hadess上传下载任务。

流水线新增SSH上传、SSH下载任务。

流水线新增Hadess上传、Hadess下载任务。

优化任务主机部署的配置与部署策略。

优化部署长时间一直运行问题。

优化任务Kubernetes的配置与执行逻辑。

新增支持Mysql数据库，安装完毕之后，根据自己安装的系统找到配置文件application.yaml，不同系统yaml文件默认位置：


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

使用MySQL数据库，需要将数据库连接信息修改为如下连接。

jdbc:
  driverClassName: com.mysql.cj.jdbc.Driver
  url: jdbc:mysql://localhost:3306/tiklab_arbess?characterEncoding=utf8&useSSL=false
  username: root
  password: darth2020

 其中数据库名需要提前在MySQL创建空的数据库，启动系统服务，系统会自动初始化数据。

支持Ubuntu系统安装，进入TikLab官网下载Ubuntu系统安装包。

下载，Ubuntu安装包下载地址，下载安装包，如 tiklab-arbess-*.*.*.deb 安装包。

安装，上传到服务器，使用 dpkg 命令安装。

启动，进入/opt/tiklab-arbess/bin目录下，执行sh startup.sh即可启动成功。

流水线新增SSH上传、下载功能，构建完成后上传指定目录，或者下载指定文件进行部署。

例如需要配置流水线，克隆代码、构建后将安装包上传至服务器，首先添加源码，这边添加GitPuk源码。

添加构建任务，以Maven构建为例，点击新阶段→构建→Maven构建。

其中模块地址输入${DEFAULT_CODE_ADDRESS}，即克隆源码地址，也可以输入绝对路径进行构建。
添加SSH上传任务，点击新阶段→工具→SSH上传。

添加上传SSH服务器地址、上传位置、文件，下图设置在构建位置用文件匹配规则上传文件。

设置完成之后点击右上角运行，运行流水线。

运行过程中，或者运行成功之后，都可以查看具体运行日志。

SSH上传成功之后，在目标服务器设置路径下，可以找到相应构建的安装包。

例如通过SSH下载安装包文件到客户端，流水线部署到客户端。首先添加SSH下载，点击新阶段→工具→SSH下载。

设置将服务器上/home/chen/tiklab.tar.gz文件，下载到192.168.10.211客户端的/opt下。

下载成功之后在客户端对安装包进行部署。点击新阶段→部署→主机部署。

这边部署文件可以使用绝对路径，也可以使用模糊路径+部署文件匹配规则进行定位。
流水线任务添加成功之后，点击右上角运行，运行流水线。

流水线新增Hadess上传、下载功能，构建完成后上传Hadess制品库，或者下载指定文件进行部署。

例如需要配置流水线，克隆代码、构建后将安装包上传Hadess制品库，首先添加源码，这边添加GitPuk源码。

其中模块地址输入${DEFAULT_CODE_ADDRESS}，即克隆源码地址，也可以输入绝对路径进行构建。
添加Hadess上传任务，点击新阶段→工具→Hadess上传。

其中Hadess服务需要登录Hadess查看，登录后点击制品库，找到上传制品库的地址。

Hadess上传成功之后，在登录Hadess找到对应制品库，可以找到相应的制品。

例如下载Hadess制品库的安装包文件到服务器，流水线部署到服务器。首先添加Hadess下载，点击新阶段→工具→Hadess下载。

设置将Hadess制品库文件，下载到服务器的/opt下。

下载成功之后在服务器对安装包进行部署。点击新阶段→部署→主机部署。

Arbess V1.1.4版本发布，支持Mysql数据库，Ubuntu系统，新增SSH及Hadess上传下载任务

Hadess是一款国产开源免费的制品管理工具，包含制品库管理、制品搜索、制品扫描等模块。本周Hadess发布V1.1.1版本，新增pypi、composer制品类型及允许批量删除版本。

优化了制品详情的弹窗，修复了删除制品最后一个版本，制品列表刷新问题

1.点击新建制品库，在选择自己要创建的类型后点击pypi输入名称后点击确定。

2.进入你刚刚创建的pypi制品库，点击操作指南根据操作指南上面的步骤即可。

1.点击新建制品库，在选择自己要创建的类型后点击composer输入名称后点击确定。

2.进入你刚刚创建的composer制品库，点击操作指南根据操作指南上面的步骤即可。

1.点击你创建的制品库，点击制品，在制品中选择版本。

2.点击右上角的打开批量操作，选中你要删除的版本，点击批量删除即可。

Hadess V1.1.1版本发布，增加pypi、composer制品类型支持

在我们开发过程中为了管理代码、加强团队协作经常会使用代码管理工具。市面上的主流产品有github、gitlab、gitee、bitbucket以及云效等代码管理工具

，现在给大家推荐另外一款开源免费、简洁易用的代码管理工具GitPuk

功能包括仓库组、代码库、分支、分支合并、代码扫描、git-lfs大文件存储等其他功能

更好地组织和管理多个相关的代码仓库。通过创建仓库组，团队可以更有效地对一系列相关联的项目进行分类。主要功能如下

简洁的仓库库管理界面，易用的属性，极大的提高了开发的效率。代码库功能大致如下

 包含代码、提交信息、分支、标签、扫描等主要功能

     通过http、ssh协议推送拉取代码，使用ssh需要先添公钥

     代码库内有提交次数统计、提交频率统计

     每个项目拥有独立的成员与权限管理模块，并且支持自定义权限

 多分支管理结合分支的合并功能，在团队开发中极大的增加了协同能力；不同分支的代码文件对比，明确的看到代码的变动情况

提高开发团队在多个分支之间高效协作。GitPuk 能够自动检测冲突，并为开发者提供直观的冲突解决方案，确保代码合并的准确性和一致性

代码扫描是一种自动化工具，旨在分析源代码以发现潜在的错误、安全漏洞和代码质量问题。

      概览分为系统级别概览、仓库级别的概览。系统概览展示最近访问的仓库以及所有仓库提交、成员的提交、以及待办信息；仓库级别概览展示该仓库的最近的提交、提交数量、该仓库的待办事项

      可以详细的记录仓库代码提交信息以及提交的代码，能够明确的知道每次提交代码相对于上次提交的修改、添加、删除

     标签用于标记特定的版本或发布，帮助团队在更新和部署时保持一致。

      通过使用 Git LFS，开发者能够更加高效地管理大文件，提升团队协作的流畅性与效率      

      节省存储空间、提高系统性能、简化备份和恢复、维护数据整洁

       统计仓库代码的提交次数、代码提交频率

GitPuk优势分为安全可靠、系统集成、简洁易用、支持多版本多终端、开源免费，详情如下

GitPuk在安全可靠通过下面多个角度体现出来

     分为备份与恢复，支持定时备份、手动备份。防止数据误删，数据丢失

      识别代码中的安全隐患。提前发现和修复问题，减少后期维护的成本和时

      包含系统权限控制、仓库权限控制，且支持自定义权限

      实时记录操作变动，追溯到那个人，什么时间操作了什么

      体系完善灵活，可单独使用，也可配置统一登录，使用soular账号中心，灵活的搭配使用Tiklb中的其他应用

     集成导入gitee、gitlab、github、bitbucket第三方应用仓库

界面简洁，可直接使用，支持一键式部署安装。

     内置多个主题色，可灵活切换，界面干净、结构清晰

      线下版本支持一键安装启动，内嵌数据库、插件、运行环境，公有云部署版本注册即可使用

     支持线上公有云版本与线下私有部署版本

 GitPuk是免费开源，代码公开透明、灵活

GitPuk免费提供下载试用版本，以及直接使用公有云版本，开发者可以立即体验其强大的代码管理功能。访问

进行下载，或访问 GitHub 获取开源版本，加入社区，贡献代码，共同打造更强大的代码管理工具。