外观
API 概览
这里将用于发布 NideNet API 的接入说明和接口参考。
建议的文档顺序
- API 地址与认证方式。
- 请求格式、签名规则和分页规则。
- 资源查询、订单、续费、替换等具体接口。
- 返回结构、状态说明与错误码。
- 调用频率和安全建议。
下一步:维护 OpenAPI 规范
实际接口确定后,在本仓库新增 docs/api/openapi.json,再把 Scalar 接入 VitePress。之后接口参数、返回字段和多语言请求示例可以由规范文件自动生成,避免文档与后端实现脱节。
不要写入敏感信息
示例中仅使用 YOUR_API_KEY 等占位符。真实 API 密钥、上游凭证和服务器密码不能提交到仓库。