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使用教程-创建空间

​项目管理工具帮助团队更高效地进行项目管理，能让你轻松规划、高效分配任务、实时跟踪进度、团队协作无缝衔接，让每个项目都高效完成。

目前常用的项目管理工具有JIRA。我今天推荐一款国产的开源免费、简洁易用的项目管理工具——Kanass。我们先通过以下的功能介绍和优势介绍来初步了解一下Kanass。

Kanass的主要功能有项目管理、事项管理、项目集管理、工时管理、统计分析等。

Kanass支持两种项目模型，每个项目还拥有独立的成员权限管理，事项类型、表单与流程设置。

Kanass支持敏捷式开发与传统的瀑布式开发两种模型

每个项目内置需求、任务、缺陷三种基本的事项类型，还可以扩展自定义的事项类型

项目内包含迭代、计划、版本、里程碑等模块功能，还集成了sward知识库和TestHubo接口测试，便于使用文档和直接测试

项目内有事项统计、工时统计功能

每个项目拥有独立的成员与权限管理模块，只用于当前项目；

事项有需求、任务、缺陷三种基本事项类型，列表，详情，甘特图，看板4种视图，还可自定义属性与流程规则

初始化需求、任务、缺陷三种基本类型，也支持自定义类型，定制专属的流程与表单；

支持列表，详情，甘特图，看板等多种视图查看；

支持自定义事项属性与状态流转

事项中的属性与状态流转也可以根据需要来自行设计；

项目集中统一管理项目的项目，在更到的层级查看统计，也有用独立的成员与权限。

对一组相互关联的项目进行统一协调和管理的过程；

以项目集为单位，用不同维度统计事项，工时，在项目集分配权限，以便高效、安全的推进多个项目；

作用与当前项目集的成员与权限

记录工时，统一查看工时并且提供工时统计功能。

可在列表中查看所有事项成员的工时，也可只查看我的工时列表

提供工时统计功能，可根据项目、成员、事项多种组合来查看工时

支持事项统计，工时统计，还有可自由组合的仪表盘功能。

含有以工时、事项等为基础的统计

以图表形式展示事项发展趋势，或以各种属性统计事项数据；根据项目，成员，事项多种组合，按照日期统计工时；

提供以项目、项目集为单位统计事项的各种报表，用户可使用这些自由组合设计仪表盘；

Kanass 支持多种项目模型，拥有强大的事项跟踪与管理功能，还有丰富的统计功能；同时做到页面简洁，上手容易，安装简单。使用备份、日志审计、权限保证数据安全。而且支持多版本多终端，集成开放，免费开源。

支持瀑布式开发与敏捷式开发两种模型，提供三种基本事项类型，还可自定义扩展；跟踪事项状态、记录工时，还可设置事项之间的各种关联，便于协调。

支持敏捷式模型与瀑布式开发两种项目模型；

提供需求、任务、缺陷等多种事项类型，还可以自定义事项类型，根据不同的事项类型定制不同的流程规则与表单属性。

提供列表视图、详情视图、看板视图和甘特图视图；

支持各种维度的事项统计，工时统计，还有可自己设计的仪表盘功能。

提供以事项、工时为单位的统计

从不同的维度统计分析事项，便于管理者充分了解项目的进程

提供不同维度的事项统计报表，用户可使用这些自由组合设计仪表盘；

可自定义事项类型、表单、流程、权限、仪表盘等。

除了内置的三种基本数据类型，还可以添加自定义事项类型

自定义流程，用于事项的状态流转

 Kanass探索:一款开源免费、简洁易用的项目管理工具

知识库管理软件是一种用于创建、组织、存储、维护和提供访问知识库的软件系统。常用的知识库软件有confluence，我今天推荐一款国内开源免费、简洁易用的知识库管理工具 - sward。我们先通过以下的功能介绍和优势介绍来初步了解一下sward。

sward的主要功能有知识库管理、文档管理等。

知识库能集中存储、组织和管理特定领域的知识，拥有独立的成员与权限，保证数据安全。

每个知识库可以看做一个独立的项目或团队工作区，里面有目录和文档，方便查找和管理。知识库可以根据项目、团队或部门进行划分，方便管理和查找。

知识库内部的目录用树形结构展示，明确上下级关系便于管理与查找；目录之间下级文档和下级目录可以相互移动，改变从属关系和顺序，操作方便。

目录与文档可以批量分享，也可以单独分享。分享的出去的文档不需要登录就可以查看，便于团队之间的资源共享。

sward支持多种文档类型，比如富文本、markdown等，适用于多种场景。还提供多种模版，帮助用户快速创建常用文档。而且集成kanass的事项，提高办公效率。还有分享与评论功能，让成员之间可以互相交流。

sward支持富文本、markdown两种文档类型，未来还会持续迭代，支持更多文档类型。

系统还内置周报、项目规划和执行、待办工作清单等多种模板，可以帮助用户快速创建常用文档。

sward 集成kanass，可以添加kanass事项到文档中，让用户可以快速查看详情

常用或者重要的文档可以收藏，便于查看。

知识库管理软件为员工提供了一个共享和交流知识的平台，可以通过评论、点赞、分享等方式实现知识的共享和讨论

不常用的文档或者不用的文档可以归档起来，不在目录树中展示，便于常用文档的查找

不用的文档和目录可以放入到回收站，放入回收站的可以恢复或者删除，避免文档问误删。

sward 做到了简洁易用，上手容易，安装配置简单。使用备份、日志审计、权限保证数据安全。而且支持多版本多终端，集成开放，免费开源。

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

线下部署版本支持一键式安装，内置数据库，不用单独安装数据库，配置也只需要在一个文件中修改参数就可以；公有云部署版本注册即可使用。

界面简洁，但是功能丰富，色彩搭配和谐，有助于减轻用户的视觉疲劳

可导入confluence数据，集成kanass项目管理系统，并提供OpenApi，便于被第三方集成

注册一个账号，可用手机号与邮箱注册

登录进入工作台选择要点击sward，就成功的开通了sward，就可进入系统使用了

sward探索 :一款开源免费、简洁易用的企业级知识管理工具

        在数字经济时代，企业数字化转型已不再是选择题，而是必答题。然而，对于许多企业，尤其是中小企业而言，数字化转型之路并非坦途，面临着技术、资金、人才等多重挑战。

星光计划

针对 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版本发布，全面支持各种附件上传预览

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

GitPuk - 一款开源免费的代码管理工具

按钮进入项目添加页面填写信息

点击项目，在项目列表页面查询项目，可根据名字，状态等搜索

项目中有计划、版本、迭代、工时、里程碑、知识库、用例库等模块，也有路线图，概况页面等辅助管理功能。表格中简单介绍一下项目内的各个模块。

项目概况中展示项目基本信息，燃尽图，里程碑，待办统计，动态列表

事项有4种视图，3种基本类型；本文先简单的演示一下新建事项。

事项分为任务、需求、缺陷3个基本的事项类型，还可以自定义其他类型

项目下的事项列表，可用列表视图、详情事项、看板视图、甘特图4种形式查看事项列表

迭代是敏捷式开发的基本功能，管理者根据上个迭代的反馈来安排之后一到两周的事项。

点击项目详情的迭代，进入页面点击添加迭代，填写信息

迭代的状态为必填，默认为未开始状态

点击进入迭代详情 -> 规划，规划事项

根据发布计划规划版本，通过版本管理事项，确保版本顺利发布。

点击项目详情的版本菜单，进入页面添加版本

版本的状态为必填状态，默认为未开始状态

添加完成进入版本详情 -> 规划，规划事项

在项目详情页面可以更改图标，名称等信息

新建项目是会初始化成员与权限，之后管理员可以根据团队管理的要求加入新成员，安排新的角色权限。

新建项目时会初始化出普通角色，admin，项目超级管理员三个角色

初始化的三个角色不可删除，可以自定义新的角色，自定义可以删除

项目超级管理员拥有所有的权限，不能修改权限范围

把某个角色设置为默认角色，新加入的成员就被赋予默认角色

项目中内置需求、任务、缺陷三种基本事项类型，分别关联一个流程与一个表单，用于事项的属性显示与状态流转；如果需要其他事项类型，还可以扩展事项类型，并设计相关的表单与流程。

项目创建时候会初始化基本事项，类型有三种，需求、任务、缺陷，不可删除修改

如果还需要其他事项类型，用户还可以自定义事项