# posthub

**Repository Path**: pengweimy/posthub

## Basic Information

- **Project Name**: posthub
- **Description**: 一个类似Postman的免费中文版API调试工具，调试API时可自动生成文档，享受高效的API调试及文档生成过程。
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-03-14
- **Last Updated**: 2022-03-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# PostHub
一个类似Postman的免费中文版API调试工具，调试API时可自动生成文档，享受高效的API调试及文档生成过程。

[官网](http://www.posthub.cn)

## 功能特性

### API调试

1.支持get、post、put、delete、patch等常用的Request请求方式；

2.支持Query Params、Body、Header等常用Request传参方式；

3.支持Bearer Auth、Basic Auth等常用Request权限认证方式；

4.支持环境变量配置，开发、测试、正式等多环境一键即可轻松切换；

5.支持全局参数配置，全局参数配合环境变量使用可彻底告别重复填写全局参数及环境切换的烦恼；

### 文档自动生成

1.调试API时选择的请求方式，填写的接口地址、请求参数等将直接作为生成文档的原始数据，不需要二次录入，大大提高文档编写的效率；

2.调试API时返回的数据可直接作为文档的响应示例，且支持一键提取响应字段（JSON格式），不需要在编写文档时一个字段一个字段的录入；

3.API文档的生成只需要手动填写请求参数的描述及响应字段的描述即可，而且配合参数/字段描述自动填充功能完全可实现全自动化生成；

### 字段描述自动填充

1.当你为将要调试的API新增一个调试参数时，如果这个同名参数在之前保存过的API中填写过描述，则系统会给自动为这个参数填写上这个同名参数填写过的描述；如果这个同名参数存在多个不同的描述，系统会自动填写最新的那个，并且当你的鼠标指针放入参数描述的填写框中时，这些不同的描述会以下拉菜单的形式供你选择；

2.在提取响应示例的字段时，同样会自动执行字段描述自动填充功能；

### 一个API多个发行版

1.PostHub支持同一个功能的API可拥有多个发行版；

2.当你的API需要迭代升级时这个特性将非常有用，你不需要新建一个不同名称的API，直接为当前API添加新版本即可；

3.API多版本的支持可以很大程序上减少接口管理的混乱；

### 发行版比对&修改详情

1.当一个API拥有多个发行版时，每个发行版之间都迭代了哪些内容？PostHub提供多版本间的对比功能，迭代内容一目了然；

2.当一个API被更新后，前端开发人员如何获悉API更新了哪些内容？PostHub提供查看修改详情的功能，更新内容一目了然；

3.多版本对比及查看修改详情可大大降低前后端开发人员间的沟通成本，提升团队整体开发效率；

### 团队协作

1.API数据支持云端同步，团队成员间一键即可更新同步;

2.内置权限管理，支持项目所有者、管理者、开发者、观察者等角色设置，满足团队间各类角色的权限需要;

3.API和文档可根据状态、相关成员进行深度筛选，团队协作更加敏捷;

[官网](http://www.posthub.cn)