📜  团结|接口介绍(1)

📅  最后修改于: 2023-12-03 15:23:02.051000             🧑  作者: Mango

团结 | 接口介绍

简介

团结是一个开源的 API 接口管理平台,旨在为开发人员提供一个方便、易用的接口管理工具。团结支持多项目管理、多人协作、权限管理等功能,使得 API 接口的管理更加高效、规范。

主要功能
  • 接口管理:支持接口的添加、编辑、排序、查询等功能。
  • 多项目管理:支持多个项目,每个项目可以独立设置权限,方便管理。
  • 团队协作:支持多人协作,每个成员可以拥有不同的权限,方便项目管理。
  • 文档管理:支持生成 API 文档,方便前端同学查看。
  • Mock 数据:支持生成 Mock 数据,方便前后端分离开发,提高开发效率。
使用方法
登录
  1. 打开团结网站,点击右上角的“登录”按钮进入登录界面。

  2. 输入用户名和密码,点击“登录”按钮即可登录成功。

创建项目
  1. 在首页点击“新建项目”按钮,进入新建项目页面。

  2. 输入项目名称、描述、项目 Logo 等信息,点击“创建”按钮即可创建成功。

创建接口
  1. 在项目页面的“接口管理”中,点击“新建接口”按钮,进入新建接口页面。

  2. 输入接口名称、URL、请求方式、参数等信息,点击“创建”按钮即可创建成功。

查看 API 文档
  1. 在项目页面的“API 文档”中,点击“生成文档”按钮,即可生成 API 文档。

  2. 点击 API 文档名称即可查看具体的 API 接口信息。

生成 Mock 数据
  1. 在项目页面的“Mock 数据”中,点击“生成 Mock 数据”按钮,即可生成 Mock 数据。

  2. 支持根据参数自动生成 Mock 数据,也支持手动编辑 Mock 数据。