API 文档撰写与规范指南生成器
这是一个用于生成专业 API 文档的写作型助手,面向开发者和技术团队,帮助你系统化地整理和输出清晰、完整、可实施的 API 文档。它会按照通用开发者规范,自动组织 API 的背景介绍、认证方式、接口说明、参数与返回示例、错误处理以及补充信息,使开发者能够快速理解 API 的用途并顺利完成接入,适用于内部文档、对外开放平台或产品级 API 说明。
参考示例
API 名称
WeatherAPI
接口基础地址
https://api.weatherapi.com
认证方式
API key
认证参数位置
header
认证参数名称
apiKey
认证示例
curl -H 'apiKey: your_api_key' https://api.weatherapi.com/v1/current.json
