Hitokoto API

本项目是基于 Teng-koa 实现的一言接口程序。相较于单纯的一言程序，此框架提供了扩展性。

以下是相对于 v0 （PHP 版本）新加入的功能：

请求统计
支持返回 JS 回调函数
支持 length 区间返回
返回 JS 的支持
支持 GBK 编码
开源数据集
A/B 无感知更新数据
官方扩展
- 网易云音乐

我们一直致力于框架的可维护性与可扩展性，这也是为什么我们选择下一版本（v2）将使用 Go 编写。
由于历史问题，此框架存在着很多不足（需要重构）的地方，我们将分 2 个大版本完全重构掉这些问题（基于 Alinode, DeepScan, CodeClimate 分析结果)

关于贡献
您可以关注我们的开发者文档，我们在其中简单介绍了本框架的基本运作机理，这将会使你为此框架开发扩展异常容易（比如：加一个 QQ 音乐接口）

外部依赖

Redis

日记

日记默认保存在 ./data/logs/Hitokoto-api.log

开始使用

常规使用

首先配置好 Node.js 环境（>=12.x)，以及 yarn。
请注意：本项目使用 Yarn v2，因此使用前请将你的 Yarn 版本更新至 v1.22.4 或更高版本。此外，项目目前不支持使用 NPM，CNPM，PNPM管理包依赖。

克隆仓库 git clone https://github.com/hitokoto-osc/hitokoto-api.git your_workdir
进入仓库 cd your_workdir
安装依赖 yarn install --production
复制配置 cp config.example.yml ./data/config.yml，根据需要对其进行配置。
启动程序 yarn start

容器使用

常规使用（需要预先安装好 redis），由于使用共享网络，请留意 8000 端口是否被占用。

docker run \
-v /path/to/your/data/dir:/usr/src/app/data \
--network host \
hitokoto/api

其他高深玩法（比如说不共享网络），还请自己摸索。

我们提供 docker-compose 配置（提供 redis 依赖），有需要的可以自行下载使用。

Benchmark

$ node -v
v14.8.0
$ wrk -t16 -c1000 -d30s --latency http://127.0.0.1:8000
Running 30s test @ http://127.0.0.1:8000
  16 threads and 1000 connections
  Thread Stats   Avg      Stdev     Max   +/- Stdev
    Latency   306.38ms   60.05ms 810.86ms   74.60%
    Req/Sec   213.41    150.01   626.00     64.98%
  Latency Distribution
     50%  311.57ms
     75%  348.58ms
     90%  372.48ms
     99%  405.50ms
  93875 requests in 30.05s, 68.19MB read
Requests/sec:   3124.36
Transfer/sec:      2.27MB
$ screenfetch
                          ./+o+-       root@DESKTOP-89TMCM6
                  yyyyy- -yyyyyy+      OS: Ubuntu 20.04 focal(on the Windows Subsystem for Linux)
               ://+//////-yyyyyyo      Kernel: x86_64 Linux 4.19.104-microsoft-standard
           .++ .:/++++++/-.+sss/`      Uptime: 2h 52m
         .:++o:  /++++++++/:--:/-      Packages: 745
        o:+o+:++.`..```.-/oo+++++/     Shell: zsh 5.8
       .:+o:+o/.          `+sssoo+/    Disk: 486G / 882G (56%)
  .++/+:+oo+o:`             /sssooo.   CPU: Intel Core i7-10875H @ 16x 2.304GHz
 /+++//+:`oo+o               /::--:.   RAM: 2602MiB / 12708MiB
 \+/+o+++`o++o               ++////.
  .++.o+++oo+:`             /dddhhh.
       .+.o+oo:.          `oddhhhh+
        \+.++o+o``-````.:ohdhhhhh+
         `:o+++ `ohhhhhhhhyo++os:
           .o:`.syhhhhhhh/.oo++o`
               /osyyyyyyo++ooo+++/
                   ````` +oo+++o\:
                          `oo++.

xkcoding / hitokoto-api