forked from Rock-Candy-Tea/hexo-circle-of-friends
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
256 lines (234 loc) · 8.03 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
<!DOCTYPE html>
<html lang="zh">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>API 接口说明</title>
<link rel="icon" href="./fcircle.png" type="image/png"> <!-- 添加 favicon -->
<style>
body {
font-family: Arial, sans-serif;
line-height: 1.6;
margin: 0;
padding: 20px;
background-color: #f4f4f4;
}
.container {
max-width: 800px; /* 设置最大宽度 */
margin: 0 auto; /* 居中对齐 */
padding: 20px; /* 内边距 */
background-color: #fff; /* 背景色 */
box-shadow: 0 2px 10px rgba(0, 0, 0, 0.1); /* 阴影效果 */
}
h1 {
color: #333;
text-align: center;
}
h2 {
color: #007BFF;
border-bottom: 2px solid #007BFF;
padding-bottom: 5px;
margin-top: 30px;
}
h2 a {
text-decoration: none;
color: #007BFF;
}
p {
color: #555;
margin: 10px 0;
}
strong {
color: #333;
}
table {
width: 100%;
border-collapse: collapse;
margin: 20px 0;
background-color: #fff;
}
th, td {
border: 1px solid #ddd;
padding: 10px;
text-align: left;
}
th {
background-color: #f2f2f2;
color: #333;
}
tr:nth-child(even) {
background-color: #f9f9f9;
}
tr:hover {
background-color: #f1f1f1;
}
code {
background-color: #f4f4f4;
padding: 2px 4px;
border-radius: 4px;
}
@media (max-width: 600px) {
body {
padding: 10px;
}
table {
font-size: 14px;
}
}
</style>
</head>
<body>
<div class="container">
<h1>API 接口说明</h1>
<h2><a href="https://friends.elykia.cn/all">/all</a></h2>
<p><strong>描述：</strong>返回数据库统计信息和文章信息列表。</p>
<p><strong>请求方式：</strong>GET</p>
<p><strong>请求参数说明：</strong></p>
<table>
<thead>
<tr>
<th align="left">字段名</th>
<th align="left">字段说明</th>
<th align="left">字段类型</th>
<th>默认值</th>
<th align="left">是否必填</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">start</td>
<td align="left">文章信息列表从按rule排序后的顺序的开始位置</td>
<td align="left">integer</td>
<td>0</td>
<td align="left">否</td>
</tr>
<tr>
<td align="left">end</td>
<td align="left">文章信息列表从按rule排序后的顺序的结束位置</td>
<td align="left">integer</td>
<td>-1</td>
<td align="left">否</td>
</tr>
<tr>
<td align="left">rule</td>
<td align="left">文章排序规则（创建时间created/更新时间updated）</td>
<td align="left">string</td>
<td>updated</td>
<td align="left">否</td>
</tr>
</tbody>
</table>
<h2><a href="https://friends.elykia.cn/friend">/friend</a></h2>
<p><strong>描述：</strong>返回数据库所有友链</p>
<p><strong>请求方式：</strong>GET</p>
<p><strong>请求参数说明：</strong>无参数。</p>
<h2><a href="https://friends.elykia.cn/randomfriend">/randomfriend</a></h2>
<p><strong>描述：</strong>从数据库随机返回指定个数个友链</p>
<p><strong>请求方式：</strong>GET</p>
<table>
<thead>
<tr>
<th align="left">字段名</th>
<th align="left">字段说明</th>
<th align="left">字段类型</th>
<th>默认值</th>
<th align="left">是否必填</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">num</td>
<td align="left">返回num个友链信息</td>
<td align="left">integer</td>
<td>1</td>
<td align="left">否</td>
</tr>
</tbody>
</table>
<h2><a href="https://friends.elykia.cn/randompost">/randompost</a></h2>
<p><strong>描述：</strong>随机返回指定个数篇文章信息</p>
<p><strong>请求方式：</strong>GET</p>
<table>
<thead>
<tr>
<th align="left">字段名</th>
<th align="left">字段说明</th>
<th align="left">字段类型</th>
<th>默认值</th>
<th align="left">是否必填</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">num</td>
<td align="left">返回num篇文章信息</td>
<td align="left">integer</td>
<td>1</td>
<td align="left">否</td>
</tr>
</tbody>
</table>
<h2><a href="https://friends.elykia.cn/post">/post</a></h2>
<p><strong>描述：</strong>指定一个链接，返回该链接的数据库内文章信息列表</p>
<p><strong>请求方式：</strong>GET</p>
<table>
<thead>
<tr>
<th align="left">字段名</th>
<th align="left">字段说明</th>
<th align="left">字段类型</th>
<th>默认值</th>
<th align="left">是否必填</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">link</td>
<td align="left">链接地址，如果为None，则随机返回一个友链的文章</td>
<td align="left">string</td>
<td>None</td>
<td align="left">否</td>
</tr>
<tr>
<td align="left">num</td>
<td align="left">指定链接的文章信息列表按rule排序后的顺序的前num篇</td>
<td align="left">integer</td>
<td>-1</td>
<td align="left">否</td>
</tr>
<tr>
<td align="left">rule</td>
<td align="left">文章排序规则（创建时间created/更新时间updated）</td>
<td align="left">string</td>
<td>created</td>
<td align="left">否</td>
</tr>
</tbody>
</table>
<h2><a href="https://friends.elykia.cn/friendstatus">/friendstatus</a></h2>
<p><strong>描述：</strong>按照指定时间划分失联/未失联的友链信息，默认距离今天2个月以上（60天以上）判定为失联友链。</p>
<p>判断逻辑是根据数据库中保存的文章进行判断，比如：某个友链在数据库中<strong>没有保存任何一篇</strong>文章，则会将其归类为失联友链。</p>
<p><strong>请求方式：</strong>GET</p>
<table>
<thead>
<tr>
<th align="left">字段名</th>
<th align="left">字段说明</th>
<th align="left">字段类型</th>
<th>默认值</th>
<th align="left">是否必填</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">days</td>
<td align="left">失联友链判定的时间，单位：天。默认值为60天，表示60天内没有文章发布的为失联。</td>
<td align="left">integer</td>
<td>60</td>
<td align="left">否</td>
</tr>
</tbody>
</table>
</div>
</body>
</html>