发布第一个 API 产品
用一个端点、一个上游和免费的 BASIC 套餐，完成导入、授权、测试与发布。
本页目录
开始前准备
- 商家邮箱已验证。
- 你有自己控制的公网 HTTPS API。本例假设 GET /health 返回 HTTP 200 和 {"status":"ok"}；若你的接口不同，请替换示例中的路径和响应。
1. 填写商品基本信息
- 进入“产品”→“新建产品”，在“基础”中选择“API 产品”。
- 例如把“产品链接后缀”填为 status-api，标题填为“服务状态 API”，说明写明返回什么、适合谁，以及如何联系你。
2. 导入接口文档并连接上游
- 打开“接口”，在“上游组”的 default 组中填入你自己的 HTTPS 基础地址，例如 https://api.your-domain.com。该地址仅为占位符，必须换成可访问的真实上游。
- 将下面的 YAML 粘贴到“OpenAPI 文档”，或保存为 status-api.yaml 后通过“导入 JSON 或 YAML”上传。保持 default 为默认上游组，暂不添加路由或转换。
- 点击“保存草稿”。保存成功后，“已解析的接口”应包含 GET /health。API 域名前缀来自商家店铺前缀，无需另填域名。
openapi: 3.0.3
info:
title: Status API
version: 1.0.0
paths:
/health:
get:
operationId: getHealth
summary: Check service health
responses:
'200':
description: Service is healthy
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: ok3. 让 BASIC 套餐可以访问这个端点
- 打开“定价”，展开 BASIC，保留月费 0、Requests 每月 10、Hard 用尽后阻断和每秒 10 次请求的默认设置。
- 在“计划可访问的接口”中勾选 GET /health，并保持套餐公开、启用。默认套餐不会自动获得导入端点的权限。
- 再次保存草稿。这个套餐不产生对象超额费用，买家开通时不需要银行卡。
4. 发送一次真实测试
- 回到“接口”，在“测试套餐”中选择 BASIC，再选择 GET /health。
- 发送请求，确认状态为 200、响应符合你的接口约定，并查看“已保存的测试证据”。
- 如需修正上游、文档或认证，保存后重新测试。测试会访问真实上游，也可能产生上游费用或实际操作。
5. 预览、发布并检查买家入口
- 打开“预览”，检查标题、说明、BASIC 价格、Requests 额度和端点权限。
- 点击“发布”。发布成功后，从“产品”打开公开商品页。
- 在未登录窗口确认“免费试用”入口和 GET /health 文档可见，再把商品链接与买家调用指南一起发给客户。
完成后检查
- 公开商品页显示 BASIC 免费试用和 GET /health 文档，买家可按调用指南开始使用。