基于 Markdown 编写接口文档、使用说明书

前端 · 2019-12-25 ·

现如今mvvm的软件开发模式很似风靡,编写接口文档也推向了风口浪尖,因此写出一份赏心悦目的文档说明书尤为重要。本文使用vuepress技术栈,实现接口文档、使用说明书等之类的文档编写。

# 图书

## 获取图书列表

- #### 接口功能
::: tip
获取图书列表
:::

- #### 请求方式 <Badge text="GET"/>

- #### 接口地址
> [/v1/book/?page=0&pageCount=10](/v1/book/?page=0&pageCount=10)

- #### 请求头部
::: warning
无需请求头部
:::

- #### 请求参数
::: danger
注意必填的数据
:::
| 参数      | 必选  | 类型 | 说明     |
| :-------- | :---- | :--- | -------- |
| page      | ture  | int  | 第几页   |
| pageCount | false | int  | 默认值10 |

- #### 响应结果
| 返回字段   | 字段类型 | 说明                  |
| :--------- | :------- | :-------------------- |
| items      | Array    | 图书列表              |
| total      | int      | 总图书数              |
| page       | int      | 第几页,值 0 为第一页 |
| count      | int      | 每页显示数目          |
| total_page | int      | 总页数                |
- #### 接口示例
> URL:[/v1/book/?page=0&pageCount=10](/v1/book/?page=0&pageCount=10)
``` javascript
{
    "items": [
        {
            "id": 8,
            "bookcat_id": 4,
            "bookcat_title": "物理",
            "title": "测试test",
            "author": "测试题",
            "summary": "1",
            "image": "1"
        },
        {
            "id": 7,
            "bookcat_id": 3,
            "bookcat_title": "历史",
            "title": "测试222",
            "author": "测试222",
            "summary": "1",
            "image": "1"
        }
    ],
    "total": 2,
    "page": 0,
    "count": 10,
    "total_page": 1
}
```

在vuepress下的效果图、 在vuepress下的效果图 、 在vuepress下的效果图

%