发布第一个 API 商品
导入 OpenAPI 文档、连接上游、选择要销售的接口和套餐,检查接口后发布到 Online Store。
本页目录
开始前准备
- 已完成 app 首页的设置清单。
- 你有自己控制的公网 HTTPS API,以及一份自包含的 OpenAPI 3.0 或 3.1 文档。本例假设 GET /health 返回 HTTP 200 和 {"status":"ok"}。
先用示例 API 试一遍(可选)
- 在 app 首页点击“用示例 API 试试”。示例 API 返回固定的示例数据,可以直接发布,用来走通一次测试购买。
- 试完后在商品编辑页点击“停止销售”,商品会在 Shopify 中变为草稿。
1. 导入接口文档
- 在 app 首页填写商品名称,点击“创建 API 商品”。
- 在“API 合约”中粘贴或上传 OpenAPI 文档(JSON 或 YAML,最大 5 MiB),或从公网 HTTPS URL 导入。
- 保存后确认页面显示文档描述的接口数量。
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: ok2. 连接上游
- 在“上游”中填写源站地址,例如 https://api.your-domain.com。每次调用都会转发到这个地址,不使用文档中的 servers。
- 如果你的 API 需要凭证,选择放在 Header 或 Query 参数中,填写名称(例如 Authorization 或 X-Api-Key)和值。值加密保存,之后不再显示;留空表示保留已保存的值。
3. 选择接口并设置套餐
- 在“要销售的接口”中取消不卖的接口。新导入的文档默认全选,所有套餐都包含选中的接口。
- 在“套餐”中启用要提供的套餐,为每个套餐设置请求额度(每天、每月或不限)和限流。价格在发布时设置。
- 保存草稿。
4. 检查接口
- 在“试一下请求”中选择接口,发送一次真实请求。源站返回低于 500 的状态码,即算通过该接口的可达性检查。
- 发布时 app 会自动对每个 GET 接口发一次请求。写入类接口(POST、PUT、PATCH、DELETE)不会被自动调用,请先手动检查,或点击“全部检查”并确认发送。
5. 设置价格并发布
- 在“发布并销售”中为每个套餐填写价格,例如 10 或 9.99。
- 点击“发布并开始销售”。首次发布会在 Shopify 中创建商品,每个套餐一个款式,并按这些价格在 Online Store 上架。
- 之后商品图片和描述可以直接在 Shopify 商品页编辑。
完成后检查
- Shopify 中出现这个 API 商品,每个套餐一个款式,并在 Online Store 上架。
