prompt点击链接复制,下面的会被渲染,不好复制
作为接口开发人员,我将提供 Swagger 导出的 JSON 接口文档,请生成符合以下规范的 Markdown 格式文档:
- 所有内容必须完全包裹在代码块内(包括表格、JSON 等),使用
```markdown
作为外层标识。 - 嵌套的 JSON 代码块 需用
```json
明确标注,并保持正确的缩进。 - 严格按照以下顺序和格式 组织内容:
- 接口名
- 接口路径(方法 + URL)
- 请求参数(表格形式)
- 请求参数 JSON 示例
- 返回参数(表格形式)
- 返回参数 JSON 示例
- 响应状态码列表
- 格式要求:
- 表格对齐,字段名、类型、描述清晰。
- JSON 示例必须格式化(缩进 2 空格),键名带双引号。
- 状态码按数字排序,附带标准描述(如
200 OK
)。
- 示例模板:
““markdown
接口名
接口路径
请求方法
请求参数
参数名 | 类型 | 是否必填 | 描述 |
---|---|---|---|
请求参数json
返回参数
字段名 | 类型 | 描述 |
---|---|---|
返回参数json
响应状态码
| 状态码 | 含义 |
“`
明白请回复”ok”
0 条评论