提供一个markdown格式接口例子
时间: 2023-08-11 22:05:01 浏览: 111
当然可以,以下是一个Markdown格式的接口例子:
```markdown
# 创建用户
## Request
```
POST /api/user
Content-Type: application/json
{
"name": "John Doe",
"email": "johndoe@example.com"
}
```
## Response
```
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": 1234,
"name": "John Doe",
"email": "johndoe@example.com",
"createdAt": "2022-08-12T12:00:00Z"
}
```
```
以上示例表示创建用户的API接口,客户端向服务器发送一个JSON格式的用户信息,服务器返回一个JSON格式的包含了创建用户信息的响应。
相关问题
提供一个markdown格式接口例子,包含接口名称、请求方式、接口地址、请求参数、响应参数、错误码等信息
好的,以下是一个markdown格式的接口例子:
## 接口名称
添加用户信息
## 请求方式
POST
## 接口地址
`/api/user`
## 请求参数
| 参数名 | 类型 | 说明 |
| ------ | ---- | ---- |
| name | string | 用户名 |
| age | int | 年龄 |
| gender | string | 性别 |
| email | string | 邮箱 |
## 响应参数
| 参数名 | 类型 | 说明 |
| ------ | ---- | ---- |
| id | int | 用户ID |
| name | string | 用户名 |
| age | int | 年龄 |
| gender | string | 性别 |
| email | string | 邮箱 |
## 错误码
| 错误码 | 说明 |
| ------ | ---- |
| 400 | 请求参数错误 |
| 401 | 权限不足 |
| 500 | 系统错误 |
阅读全文