什么是Markdown?
2024-02-27
Markdown是一种轻量级标记语言,排版语法简洁,让人们更多地关注内容本身而非排版,编写API文档时,一般采用Markdown语言。它使用易读易写的纯文本格式编写文档,可与HTML混编,可导出 HTML、PDF 以及本身的 .md 格式的文件。因简洁、高效、易读、易写,Markdown被大量使用,如Github、Wikipedia、简书等。
## 语法结构
– [Markdown 标题语法](https://markdown.com.cn/basic-syntax/headings.html),要创建标题,请在单词或短语前面添加井号 (
#
) 。#
的数量代表了标题的级别。
– [Markdown 段落语法](https://markdown.com.cn/basic-syntax/paragraphs.html),要创建段落,请使用空白行将一行或多行文本进行分隔。
– [Markdown 换行语法](https://markdown.com.cn/basic-syntax/line-breaks.html),在一行的末尾添加两个或多个空格,然后按回车键,即可创建一个换行(<br>
)。
– [Markdown 强调语法](https://markdown.com.cn/basic-syntax/emphasis.html),要加粗文本,请在单词或短语的前后各添加两个星号(asterisks)或下划线(underscores)。要用斜体显示文本,请在单词或短语前后添加一个星号(asterisk)或下划线(underscore)。
– [Markdown 引用语法](https://markdown.com.cn/basic-syntax/blockquotes.html),要创建块引用,请在段落前添加一个 >
符号。
– [Markdown 列表语法](https://markdown.com.cn/basic-syntax/lists.html),要创建有序列表,请在每个列表项前添加数字并紧跟一个英文句点。要创建无序列表,请在每个列表项前面添加破折号 (-)、星号 (*) 或加号 (+) 。
– [Markdown 代码语法](https://markdown.com.cn/basic-syntax/code.html),要创建代码块,请将代码块的每一行缩进至少四个空格或一个制表符。
– [Markdown 分隔线语法](https://markdown.com.cn/basic-syntax/horizontal-rules.html),要创建分隔线,请在单独一行上使用三个或多个星号 (***
)、破折号 (---
) 或下划线 (___
) ,并且不能包含其他内容。
– [Markdown 链接语法](https://markdown.com.cn/basic-syntax/links.html),语法格式是 [超链接显示名]超链接地址 "超链接title")
。
– [Markdown 图片语法](https://markdown.com.cn/basic-syntax/images.html),语法格式是 “。
– [Markdown 转义字符语法](https://markdown.com.cn/basic-syntax/escaping-characters.html),要显示原本用于格式化 Markdown 文档的字符,请在字符前面添加反斜杠字符
– [Markdown 内嵌 HTML 标签](https://markdown.com.cn/basic-syntax/htmls.html),对于 Markdown 涵盖范围之外的标签,都可以直接在文件里面用 HTML 本身。如需使用 HTML,不需要额外标注这是 HTML 或是 Markdown,只需 HTML 标签添加到 Markdown 文本中即可。
## Markdown文档案例
“`
REST API 能够以灵活、轻量级的方式集成应用程序,并已成为微服务架构中连接组件的最常用方法。在使用过程,会有各类困惑或疑问需要厘清,才能设计更好的API及实施API战略。
## REST API概念相关的问题
– [API与REST API的区别?](https://www.explinks.com/blog/api_vs_rest_api)
– [SOAP API与REST API的区别?](https://www.explinks.com/blog/soap_api_vs_rest_api)
– [Web API与REST API的区别?](https://www.explinks.com/blog/web_api_vs_rest_api)
– [OpenAPI与REST API的区别?](https://www.explinks.com/blog/rest_api_vs_open_api)
– [WebSocket API与REST API区别?](https://www.explinks.com/blog/rest_api_vs_websocket_api)
## REST API设计
– [什么是REST 设计原则?](https://www.explinks.com/wiki/rest-api/)
– [GraphQL 和 REST 怎么选择?](https://zhuanlan.zhihu.com/p/84916814)
– [如何评估REST API成熟度?](http://restful.p2hp.com/resources/richardson-maturity-model)
## 开放REST API接口案例
– [身份证二要素](https://www.explinks.com/api/%E8%BA%AB%E4%BB%BD%E8%AF%81%E4%BA%8C%E8%A6%81%E7%B4%A0/K_VERIFY_ID_2)
– [增值税发票OCR识别](https://www.explinks.com/api/%E5%A2%9E%E5%80%BC%E7%A8%8E%E5%8F%91%E7%A5%A8OCR%E8%AF%86%E5%88%AB/K_VERIFY_OCR_INVOICE)
– [Summary Box API](https://www.explinks.com/api/Summary%20Box%20API/SCD20240125579615b0b199)
“`
## 在线编辑体验
[编辑器](https://markdown.com.cn/editor/)