根据 OpenAPI 规范或一个端点的自然语言描述生成 Markdown API 文档草稿。文档可能整理端点、身份验证、参数、请求与响应示例及错误码。
按确认的实际用量结算，未使用的预留额度会恢复到可用余额。
Strale
根据 OpenAPI 规范或一个端点的自然语言描述生成 Markdown API 文档草稿。文档可能整理端点、身份验证、参数、请求与响应示例及错误码。
根据 OpenAPI 规范或一个端点的自然语言描述，生成 Markdown API 文档草稿。根据输入内容，文档可能整理端点信息、身份验证、参数、请求与响应示例及错误码。
为[我的网店订单配送查询]写一份 API 文档，说明顾客输入[订单号]后可以查看[最新配送进度]。
此生成器根据你提供的资料起草文档，不会验证正在运行的 API。发布前请确认路径、身份验证、参数名称和示例均与实际实现一致。
开始前检查当前输入要求、可用状态和最高预留费用。
| 字段 / 路径 | 类型 | 是否必填 | 含义 |
|---|---|---|---|
queryParamsqueryParams | object | 选填 | |
OpenAPI 规范queryParams.openapi_spec | string | 选填 | 粘贴希望转换为 Markdown 文档的 API 规范。 |
端点描述queryParams.endpoint_description | string | 选填 | 用自然语言描述一个 API 端点，以生成文档草稿。 |
{
"type": "object",
"required": [],
"properties": {
"queryParams": {
"type": "object",
"properties": {
"openapi_spec": {
"type": "string"
},
"endpoint_description": {
"type": "string"
}
}
}
},
"additionalProperties": false
}暂未配置返回字段说明。
关于支持的输入和可能生成的文档内容，请查看 Strale 能力目录。
说明文档给谁看、希望对方了解什么。例如：[写给需要向顾客说明订单配送查询方式的店主。]
为[我的网店订单配送查询]写一份 API 文档，说明顾客输入[订单号]后可以查看[最新配送进度]。
对照实际使用方式，检查步骤和例子是否准确。此工具只生成草稿，不会实际试用这项服务。
不需要。你可以在 endpoint_description 中用自然语言描述一个端点；OpenAPI 规范是另一种支持的输入。
不会。它根据你提供的资料生成文档，不会检查正在运行的服务。请对照实际实现核验路径、身份验证、参数和示例。