欢迎访问本项目的 API 文档!以下是关于「api.html」页面的核心内容说明:
📚 什么是 API 文档?
API 文档是开发者用于描述接口功能、参数规范及使用示例的技术文档。
通过本页面,您可以快速了解如何与项目提供的 API 进行交互。
🛠️ 快速开始
基础信息
- 当前文档版本:1.0.0
- 支持的请求方法:
GET
,POST
,PUT
,DELETE
- 基础路径:
/api/
请求格式
- 所有请求需携带
Content-Type: application/json
头 - 错误响应示例:
{ "error": "Invalid request", "code": 400 }
- 所有请求需携带
📌 常见接口
📷 相关图示
如需深入了解接口设计规范,请查看 API 设计指南。