Skip to content

Commit 0793952

Browse files
committed
完善了三个接口的描述
1 parent 0bbde66 commit 0793952

1 file changed

Lines changed: 59 additions & 7 deletions

File tree

README.md

Lines changed: 59 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
<!--
2+
* @Date: 2020-03-23 00:12:04
3+
* @Author: MemoryShadow
4+
* @LastEditors: MemoryShadow
5+
* @LastEditTime: 2020-07-01 17:46:47
6+
* @Effect: Do not edit
7+
-->
18
# MemoryShadow Web站点简介
29

310
对于Web站点的拓展化管理与信息库的拓展,目的是创造移植性更高的站点
@@ -30,21 +37,68 @@
3037

3138
### 彩虹屁
3239

33-
`此项目前正在编辑中`
40+
噢,如您所见,我们这个API来自于[沙雕APP](https://chp.shadiao.app/ "点击前往"),感谢他的支持.
3441

35-
噢,如您所见,我们这个API来自于[沙雕APP](https://chp.shadiao.app/ "点击前往"),感谢他的支持,我在这里只是为我的其他项目准备好了接口,这部分并不是为所有人准备的,而是为特定应用准备的.
42+
这个接口的调用十分的简单,它仅接收GET请求,而不理会POST请求,每次刷新这个URL都会得到一句新的"彩虹屁"
3643

37-
### ErrorMsg
44+
`https://memoryshadow.freetzi.com/Template/Public/ToolAPI/?Mode=Ajax&Function=CaiHongPi`
3845

39-
`此项目前正在编辑中`
46+
您只需要对此URL提交请求即可.
47+
48+
* 注意:使用Ajax时需要联系我授权域名,否则可能会因为用户浏览器的默认设置,请求会被拦截
49+
50+
|类型|项名|内容|
51+
|---|---|---
52+
|返回|格式|Text
53+
54+
### ErrorMsg
4055

4156
这是一个对Http错误代码进行友好描述与调侃的项目,在您的网站内容暂时无法访问时,您可以将此处内容作为错误页面返回.
4257

58+
通过向下方URL进行提交请求,将会以Json格式返回您请求的HTTP状态码友好的解释与调侃.
59+
60+
`https://memoryshadow.freetzi.com/Template/Public/ToolAPI/?Mode=Ajax&Function=ErrorMsg`
61+
62+
直接调用此URL链接并不会返回数据,因为缺少了重要的组成部分,您应该以GET方式提交`ErrorCode`项,值是你想要获取的HTTP状态码.例如以下URL将会返回一句对HTTP错误码503的错误原因与调侃:
63+
64+
`https://memoryshadow.freetzi.com/Template/Public/ToolAPI/?Mode=Ajax&Function=ErrorMsg&ErrorCode=503`
65+
66+
* 注意:不能超过GET方法字数上限,可能需要对数据切片
67+
68+
* 注意:使用Ajax时需要联系我授权域名,否则可能会因为用户浏览器的默认设置,请求会被拦截
69+
70+
|类型|项名|内容|
71+
|---|---|---
72+
|参数|ErrorCode|一个合格的HTTP状态码
73+
|返回|格式|Json
74+
4375
### Google Translate API
4476

4577
`此项目前正在编辑中`
4678

47-
Google Translate,全球最好的翻译平台,这是它的API调用(请省着点花)
79+
Google Translate,全球最好的翻译平台,许多人在尝试调用它的API时都会因为它多变的验证格式头疼,在这里您可以直接调用,其他的交给我们来处理
80+
81+
通过对于以下URL提交GET请求,将会按照你的要求向Google Translate的服务器提交翻译请求
82+
83+
`https://memoryshadow.freetzi.com/Template/Public/ToolAPI/?Mode=Ajax&Function=Translate`
84+
85+
[ErrorMsg](#ErrorMsg)项目一样,直接打开这个链接不会真正的有效,因为还缺少关键的参数`Query`,对上面这个链接以GET请求的模式附上这个提交,例如:
86+
87+
`https://memoryshadow.freetzi.com/Template/Public/ToolAPI/?Mode=Ajax&Function=Translate&Query=Hello%20world`
88+
89+
将会翻译Query中的单词.其他的参数在下方的列表中可以查到.
90+
91+
* 注意:不能超过GET方法字数上限,可能需要对数据切片
92+
93+
* 注意:使用Ajax时需要联系我授权域名,否则可能会因为用户浏览器的默认设置,请求会被拦截
94+
95+
|类型|项名|内容|备注|
96+
|---|---|---|---
97+
|参数|Query|要翻译的文本|必须
98+
|参数|SourceLanguage|指定一个源语言的语言代码|[暂未开放]可选,默认为自动识别
99+
|参数|Language|指定目标语言的语言代码|[暂未开放]可选,默认为zh-CN
100+
|参数|Source|指定翻译服务商|[暂未开放]可选,默认为Google(也只有此项)
101+
|返回|格式|Json|
48102

49103
## Projects
50104

@@ -57,5 +111,3 @@ Google Translate,全球最好的翻译平台,这是它的API调用(请省着点
57111
`此项目前正在编辑中`
58112

59113
一个为Minecraft玩家们准备的Web资源,借助3DBox,可以快速的在Web上构建方块,例如展示您的主城
60-
61-

0 commit comments

Comments
 (0)