Markdown语法与接口文档例子

Markdown 宝典

0. 目录

  1. 文字编辑
  2. 分级标题
  3. 超链接
  4. 列表
  5. 引用
  6. 插入图像
  7. 标注
  8. 表格
  9. 代码框

1. 文字编辑

操作:

*斜体* , _斜体_
**粗体**
***加粗斜体***
~~删除线~~
<u>下划线</u>
***分割线 , ---

效果:

斜体文本

斜体文本

粗体文本

粗体文本

粗斜体文本

粗斜体文本

这是加斜粗体

这是删除线

这是下划线


2. 分级标题

操作:

# + 空格 = 一级标题
## + 空格 = 二级标题
### + 空格 = 三级标题
#### + 空格 = 四级标题
##### + 空格 = 五级标题
###### + 空格 = 六级标题

一级标题

二级标题

三级标题

四级标题

五级标题
六级标题,最小的了

3. 超链接

3.1 文本链接

操作:

[显示的文字](目标地址链接)
[Github](https://github.com/BeyondLam)

效果:

Github

3.2 地址链接

操作:

<https://github.com/BeyondLam>

效果:

https://github.com/BeyondLam

4. 列表

4.1 无序列表

操作:

- 一级列表
+ 二级列表
* 三级列表
注: 两个空格算一级

效果:

  • 一级列表
  • 一级列表
  • 一级列表

    • 二级列表
    • 二级列表
    • 二级列表

      • 三级列表
      • 三级列表
      • 三级列表

4.2 有序列表

操作:

1.一级列表
2.二级列表
3.三级列表
  1. 一级列表
  2. 二级列表
  3. 三级列表

4.3 任务列表

操作:

- [ ]早睡
- [ ]早起
- [ ]按时吃饭
- [x]不可能

效果:

  • 早睡
  • 早起
  • 按时吃饭
  • 不可能

5. 引用

操作:

> 这是一级引用

效果:

这是一级引用

这是二级级引用

这是三级引用

这是四级引用

这是五级引用

这是六级引用

有七级引用

你想多少层引用?

都行,依你

6. 插入图像

操作:

![图片说明文字](图片路由)
![好音宫的图呀](https://cdn.hicaiji.com/halo/yg_1593417121976_1595006205179.jpg)

效果:

一张图呀

7. 标注

操作:

关键字A[^1]
... 
文末
[^1]:解释语

我是音宫1呀~

8. 表格

操作:

|姓名|年龄|性别|学校|
| :----: | ---: | :--: | :----- | # 这个:意思是文字排序位置(左中右)
| 好音宫 |   18 |  男  | 清 - 华   |
| 扑街仔 |   22 |  男  | 家里蹲 |

效果:

姓名 年龄 性别 学校
好音宫 18 清 - 华
扑街仔 22 家里蹲

9. 代码区

9.1 代码块

操作:

```python
你的代码
```

效果:

print("hello world")

9.2 单行代码

操作:

`print("hello 音宫")`

接口文档

1. 寻物启示文档

1.1 发布内容

描述

  • 发布寻物启示或者失物招领内容

请求URL

  • { {url}}/mini/push

请求方式

  • POST

请求参数

参数名 类型 是否必填 说明
wx_openid 字符串 微信的openid
type 字符串 类型 1是寻物启事 2是失物招领
text 字符串 内容
address 字符串 地址
phone 字符串 手机号
wechat 字符串 微信号

请求示例

	{
    
    
	"wx_openid":"othLO4pHiKhkCdWKPNCi5sssasczxcwrty1C",
	"type":1,
	"text":"我是测试内容",
	"address":"我的地址是:。。。。。",
	"phone":"12345678900",
	"wechat":"asdasd"
	}

返回示例

	{
    
    
	"code": 200,
	 "id": 5
	}

失败返回:

	{
    
    
	"code": 400,
     "msg":"请求失败,请重试"
	}

1.2上传图片

描述

  • 内容添加图片

请求URL

  • { {url}}/mini/upload/detail/img

请求方式

  • POST

请求参数

参数名 类型 是否必填 说明
id 整数 form的数据
img 图片 file 图片二进制流

请求示例

返回示例

成功返回:

	{
    
    
		"code": 200,
   	    "image_url": "https://hnnydx.oss-cn-shanghai.aliyuncs.com/mini/vs1/detail/20200131185655_74.jpeg",
   	    "msg": "保存图片数据成功"
	}

失败返回:

	{
    
    
	    "code": 400,
	    "msg": "参数错误"
	}
	
	或者
	
	{
    
    
	    "code": 400,
	    "msg": "内容不存在"
	}

1.3 获取详情

描述

  • 获取寻物启示的内容详情

请求URL

  • { {url}}/mini/getdetail?id={ {id}}

请求方式

  • GET

请求参数

参数名 类型 是否必填 说明
wx_openid 字符串 微信的openid
type 字符串 类型 1是寻物启事 2是失物招领
text 字符串 内容
address 字符串 地址
phone 字符串 手机号
wechat 字符串 微信号

请求示例

	{
    
    
	"wx_openid":"othLO4pzxxczxcV",
	"type":1,
	"text":"我在你家掉了我的心,帮我保管一下",
	"address":"你家",
	"phone":"13025134531",
	"wechat":"130251332514"
	}

返回示例

成功返回:

	{
    
    
	"code": 200,
	 "id": 5
	}

失败返回:

	{
    
    
	    "code": 400,
	    "msg": "内容不存在"
	}

关于我

欢迎来赞我的GitHub
Hi菜鸡-个人主页


  1. JamKung ↩︎

猜你喜欢

转载自blog.csdn.net/Jake_Lam/article/details/109294831
今日推荐