「唐言」公共 API 及 GitHub Repo 使用指南

Victor_Huang 2019-08-26 12:12:07 2020-04-02 17:21:39

「唐言」是受「一言」API 启发,于 2018 年创建的 LYOI 公共项目。事实证明「唐言」已经成为 LYOI 一道亮丽的风景线。

由于「唐言」是一个致力于「记录唐老师的名言警句」的公共项目,需要不断地更新。以及可能有部分同学想在其它地方使用「唐言」,更有许多同学想要为「唐言」添砖加瓦但并不清楚如何操作。因此本指南被编写用来解决上述问题。

添加「唐言」

「唐言」项目在 GitHub 上托管,项目地址为 https://github.com/SDLYYZ/Tangokoto
目前 (截止至 2019 年 8 月 26 日),SDLYYZ 组织有 3 位管理员,分别为 Menci, Victor Huang, Masellum。你可以向他们发送电邮来申请加入。或者在唐群里广播一声找他们。

如果他们没有回应,你也可以先 fork 一下 Repo,然后提出 Pull Request。

关于 GitHub 网页端的使用可参考 GitHub项目管理基本操作 - loushengyue - CSDN博客

如果你实在学不会 Git,也可以提出 Issue 等待组织成员进行添加。

欢迎有责任心以及认真细致的同学申请成为管理员。

添加新的唐言之后,服务器的同步过程最多需要 30 分钟。

完整「唐言」下载

你当然可以在项目主页上下载,但你也可以选择使用 jsDelivr 提供的 GitHub CDN。 jsDelivr 下载入口

API 接口使用

接口地址为 https://api.lyoi.cc/tangokoto 。调用方法为 GET。

接口参数

目前支持的格式和 GET 参数如下:

  • JSON: type=json 或不填
  • JSONP: type=jsonp
  • 纯文本: type=plain
  • 单函数 JavaScript: type=js

注意,如果使用 JSONP,你还需要传入一个 _callback 参数为你的回调函数名,默认回调函数为 doTangokoto()

你也可以传入 id=XX 的参数来指定返回某一条「唐言」,id 为行号 -1,请注意,不同时间同一 id 对应的唐言可能不同,若 id 越界则随机返回一条。

返回数据

JSON、JSONP 模式和「一言」兼容。纯文本不带换行符。JavaScript 模式返回一个名为 doTangokoto() (2020 年 2 月 26 日更新) 的函数。

JSON 示例

curl 'https://api.lyoi.cc/tangokoto'

{"id":53,"hitokoto":"\u8fd9\u4e2a\u82f1\u96c4\u8054\u76df\u662f\u4e2a\u4ec0\u4e48\u554a\uff1f\uff1f\n","from":"\u5510\u8001\u5e08"}

JSONP 示例

curl 'https://api.lyoi.cc/tangokoto?type=jsonp&_callback=glztxdy'

glztxdy({"id":71,"hitokoto":"\u4ed6\u51fa\u4ec0\u4e48\u53d8\u6001\u9898\uff0c\u4f60\u5c31\u7528\u4ec0\u4e48\u53d8\u6001\u601d\u60f3\u628a\u5b83\u89e3\u51b3\u4e86\uff01\uff01\uff01\n","from":"\u5510\u8001\u5e08"})

纯文本示例

curl 'https://api.lyoi.cc/tangokoto?type=plain'

做题的时候不要讨论,像正式考试一样!!!

单函数 JavaScript 示例

curl 'https://api.lyoi.cc/tangokoto?type=js'

function doTangokoto(){document.write("<span class='hitokoto' title='Tangokoto'>这还真是大白天的见了鬼了!!!</span>");}

共 1 条回复

Logey

唐群:566182679(