怎样在Apipost中设计出实用又好看的API文档

Apipost一直推荐文档先行的API设计理念，在Apipost中可以添加Markdown格式的文本，用以储备文档和API文档设计。
作为一种轻量级标记语言，Markdown在撰写文档、博客文章、README文件以及网站内容上被广泛使用。

如何在Apipost中设计出漂亮的文档？

Apipost近期发布的7.1.9版本更新中，Apipost Markdown文本喜提功能更新～

「新增7种颜色的高亮块展示、五种告示方式、折叠块、各种Mermarid图表（流程图、时序图等）」

合理利用这些图表，漂亮的文档信手拈来！～

小编这里以一个简单登录接口文档来展示更新后的Apipost Markdown有什么不同～

01.高亮块&告示块

推荐使用高亮块展示代码片段，通过选择合适的颜色，使代码更加醒目。还可以使用告示方式，例如警告、提示等，来突出重要信息。通过在编辑器中插入或输入下方语法：

02.折叠块

折叠块功能可以帮助我们组织文档结构，将一些内容进行折叠隐藏，使得文档加清晰易读。折叠块语法：

03.表格

请求参数可以通过插入表格展示：

04.响应结果

响应结果插入代码块后的实时预览：

05.Mermarid图表

Apipost 支持插入流程图、时序图、类图等 Mermarid 图表。你可以使用 Mermarid 的语法来创建这些图表，并将其插入到文档中。

例如：登录接口流程图：使用 Mermarid 的语法或直接在Apipost中插入创建流程图表：

 

登录接口时序图：使用 Mermarid 的语法或直接在Apipost中插入来创建时序图表：