> ## Documentation Index
> Fetch the complete documentation index at: https://base.bangwu.me/llms.txt
> Use this file to discover all available pages before exploring further.

# Apifox

> Apifox 是集 API 设计、接口调试、Mock 数据生成与文档自动化于一体的协作平台，适合个人项目与小团队。本文介绍按业务模块整理接口、调试鉴权参数、配置 Mock 实现前后端并行开发、分享文档的完整工作流，以及命名一致性、环境变量管理与敏感信息检查等实践建议。

[Apifox](https://apifox.com/) 是我常用的 API 协作工具，可以把接口设计、调试、Mock、测试和文档放在一个地方维护。对个人项目和小团队都比较省心。

## 适合什么场景

* 调试 REST API
* 统一管理接口文档
* 给前端提供 Mock 数据
* 在接口变更时减少沟通成本

## 我主要怎么用

1. 先在项目里按模块整理接口。
2. 用调试面板直接验证请求参数、鉴权和返回值。
3. 需要前后端并行开发时，再打开 Mock。
4. 接口稳定后，把文档直接分享给协作者。

## 使用建议

* 命名尽量和后端路由、业务模块保持一致。
* 公共环境变量统一管理，避免测试地址写死在请求里。
* 对外分享前，先检查示例数据里有没有敏感信息。

![bangwu\_20240521131017](https://p0.meituan.net/csc/2af07a2f9a712959a589a7f4ebdb8c96101444.webp)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.