在项目开发的时候，前后端分离的网站项目或者APP接口访问等都需要规范的接口文档。这样方便团队的开发和接口的规范统一，大大的提升了团队的协作开发能力。根据项目团队的需要，可以使用很多工具写接口文档，例如excel 或者word。此处我们介绍一下.md的形式。习惯之后会很快速，尤其是返回的信息值，复制过来很直观。使用MarkdownPad2还可以导出HTML或者PDF格式这样直接就是一篇漂亮的文章或文档，直接看展示图。

## 得到博客文章的列表（有分页） ##

### 接口地址 ###
<pre>
http://www.dodobook.net/post/list
</pre>

### 传递参数 ###
<pre>
cate_id         分类ID Array（不传显示全部）	[1,3,6]
page_num        当前页码（可不传）	默认 1
page_size       每页记录数目（可不填）	默认 10
</pre>

### 返回值 ###
<pre style="background:#222;color:#35b558">
total: 108,
list: [
    {
        id: 2718,
        cate_id: 2,
        cate_name: "php",
        view_cnt: "1005",
        cate_name: "php",
        name: "Yii2中配置使用连接多个数据库连接",
        url: "http://www.dodobook.net/php/2718",
        post_date: "2016-08-20 20:10:08",
        img_logo: "/upload/img/aaa.png",
    },
    {
        id: 2718,
        cate_id: 2,
        cate_name: "php",
        view_cnt: "1005",
        cate_name: "php",
        name: "PHP实现网址短链接转换的方法",
        url: "http://www.dodobook.net/php/2710",
        post_date: "2016-08-16 20:10:08",
        img_logo: "/upload/img/addsaafff.png",
    }
]
</pre>

同时附上markdown默认情况下的语法和简介

# 欢迎使用 MarkdownPad 2 #
## Welcome to MarkdownPad 2 ##

**MarkdownPad** is a full-featured Markdown editor for Windows.

### Built exclusively for Markdown ###

Enjoy first-class Markdown support with easy access to  Markdown syntax and convenient keyboard shortcuts.

Give them a try:

- **Bold** (`Ctrl+B`) and *Italic* (`Ctrl+I`)
- Quotes (`Ctrl+Q`)
- Code blocks (`Ctrl+K`)
- Headings 1, 2, 3 (`Ctrl+1`, `Ctrl+2`, `Ctrl+3`)
- Lists (`Ctrl+U` and `Ctrl+Shift+O`)

### See your changes instantly with LivePreview ###

Don't guess if your [hyperlink syntax](http://markdownpad.com) is correct; LivePreview will show you exactly what your document looks like every time you press a key.

### Make it your own ###

Fonts, color schemes, layouts and stylesheets are all 100% customizable so you can turn MarkdownPad into your perfect editor.

### A robust editor for advanced Markdown users ###

MarkdownPad supports multiple Markdown processing engines, including standard Markdown, Markdown Extra (with Table support) and GitHub Flavored Markdown.

With a tabbed document interface, PDF export, a built-in image uploader, session management, spell check, auto-save, syntax highlighting and a built-in CSS management interface, there's no limit to what you can do with MarkdownPad.

过去30年IT信息技术产业经历了三个王朝：IBM创造的硬件王朝、微软创造的软件王朝和谷歌创造的互联网王朝。