Skip to content

Latest commit

 

History

History
205 lines (162 loc) · 5.88 KB

README.md

File metadata and controls

205 lines (162 loc) · 5.88 KB
Raw

Chahoutan

The backend of contents in Chahoutan.

茶后谈内容的后端。

构建和使用

docker build . -t ghcr.io/teaconmc/chahoutan:master
docker run --rm ghcr.io/teaconmc/chahoutan:master

工作目录文件：

  • chahoutan-indexes 目录为茶后谈文本索引。
  • chahoutan-spring.log 文件为 Spring Boot 运行日志。
  • chahoutan-tokens.txt 文件为私有 API 鉴权 token 列表。

数据库格式

数据库使用 PostgreSQL 10+ 版本。

CREATE TABLE chahoutan_images
(
    id bpchar(64) NOT NULL,
    upload_time timestamptz NOT NULL,
    CONSTRAINT chahoutan_images_pkey PRIMARY KEY (id)
);

CREATE TABLE chahoutan_image_binaries
(
    image_id bpchar(64) NOT NULL,
    image_binary bytea NOT NULL,
    suffix varchar(16) NOT NULL,
    CONSTRAINT chahoutan_image_binaries_pkey PRIMARY KEY (image_id, suffix),
    CONSTRAINT fk1jyvtay33k1u0n0q20dt45euv FOREIGN KEY (image_id) REFERENCES chahoutan_images (id)
);

CREATE TABLE chahoutan_image_sizes
(
    height int2 NOT NULL,
    width int2 NOT NULL,
    image_id bpchar(64) NOT NULL,
    CONSTRAINT chahoutan_image_sizes_pkey PRIMARY KEY (image_id),
    CONSTRAINT fkpro1cul2fyb1xs1yt1sut2ti6 FOREIGN KEY (image_id) REFERENCES chahoutan_images (id)
);

CREATE TABLE chahoutan_corrections
(
    id uuid NOT NULL,
    text_content text NOT NULL,
    upload_date date NOT NULL,
    revision_id uuid NOT NULL,
    CONSTRAINT chahoutan_corrections_pkey PRIMARY KEY (id),
    CONSTRAINT fkgrxyryioaeetwf82c2jr4ih1p FOREIGN KEY (revision_id) REFERENCES chahoutan_revisions (id)
);

CREATE TABLE chahoutan_editors
(
    post_id int4 NOT NULL,
    editor varchar(32) NOT NULL,
    CONSTRAINT chahoutan_editors_pkey PRIMARY KEY (post_id, editor),
    CONSTRAINT fkriftc1x04r4jj2uvbg7g3bfuo FOREIGN KEY (post_id) REFERENCES chahoutan_posts (id)
);

CREATE TABLE chahoutan_post_anchors
(
    revision_id uuid NOT NULL,
    link text NOT NULL,
    anchor text NOT NULL,
    CONSTRAINT chahoutan_post_anchors_pkey PRIMARY KEY (revision_id, anchor),
    CONSTRAINT fk66omt1yfcmam8rn9s3f5qh6pq FOREIGN KEY (revision_id) REFERENCES chahoutan_revisions (id)
);

CREATE TABLE chahoutan_post_footnotes
(
    revision_id uuid NOT NULL,
    footnote text NOT NULL,
    footnote_ordinal int4 NOT NULL,
    CONSTRAINT chahoutan_post_footnotes_pkey PRIMARY KEY (revision_id, footnote_ordinal),
    CONSTRAINT fk7epb56mbnx4mqd2vvu5k7fv46 FOREIGN KEY (revision_id) REFERENCES chahoutan_revisions (id)
);

CREATE TABLE chahoutan_post_images
(
    revision_id uuid NOT NULL,
    image_id bpchar(64) NOT NULL,
    image_ordinal int4 NOT NULL,
    CONSTRAINT chahoutan_post_images_pkey PRIMARY KEY (revision_id, image_ordinal),
    CONSTRAINT fk4trlnovjnjoo7hyq0nsnl2ruv FOREIGN KEY (image_id) REFERENCES chahoutan_images (id),
    CONSTRAINT fklitxm6ei05ki14subnnr03nji FOREIGN KEY (revision_id) REFERENCES chahoutan_revisions (id)
);

CREATE TABLE chahoutan_posts
(
    id int4 NOT NULL,
    revision_id uuid NULL,
    CONSTRAINT chahoutan_posts_pkey PRIMARY KEY (id),
    CONSTRAINT fk6aj0lwnht6m0eag2iojpdsato FOREIGN KEY (revision_id) REFERENCES chahoutan_revisions (id)
);

CREATE TABLE chahoutan_revisions
(
    id uuid NOT NULL,
    creation_time timestamptz NOT NULL,
    text_content text NOT NULL,
    post_id int4 NOT NULL,
    CONSTRAINT chahoutan_revisions_pkey PRIMARY KEY (id),
    CONSTRAINT fk8ll74gix3lf472w3wdoleb37d FOREIGN KEY (post_id) REFERENCES chahoutan_posts (id)
);

CREATE TABLE chahoutan_search_indexes
(
    id uuid NOT NULL,
    search_index_vector tsvector NOT NULL,
    post_id int4 NOT NULL,
    CONSTRAINT chahoutan_search_indexes_pkey PRIMARY KEY (id),
    CONSTRAINT fkmy9vvhqg1ybcv79wyl8jv3ec7 FOREIGN KEY (post_id) REFERENCES chahoutan_posts (id)
);

CREATE INDEX chahoutan_search_index_vector_idx ON chahoutan_search_indexes USING gin (search_index_vector);

HTTP API 格式

HTTP 后端位于 48175 端口。

参数说明：

  • {{query}} 为检索字符串，用于检索茶后谈。
  • {{post-id}} 为正整数，代表茶后谈的期数。
  • {{revision-id}} 为 UUID，代表茶后谈的一次修订。
  • {{image-id}} 为图片索引，为 128 bit 长（64 字符）的十六进制。

公开访问 API：

# 显示最新 API 版本
GET /

# RSS / Atom
GET /feed
GET /feed/atom

# 查看重新索引已有茶后谈的状态
GET /v1/refresh

# 获取图片 metadata / png 格式 / webp 格式
GET /v1/images/{{image-id}}
GET /v1/images/{{image-id}}.png
GET /v1/images/{{image-id}}.webp

# 查看或检索已公开的茶后谈 / 查看某次茶后谈修订
GET /v1/posts
GET /v1/posts?q={{query}}
GET /v1/posts/{{post-id}}
GET /v1/posts/{{post-id}}/images
GET /v1/posts/{{post-id}}/editors
GET /v1/posts/{{revision-id}}
GET /v1/posts/{{revision-id}}/images

私有访问 API：

需添加 Authorization: Bearer <token> 请求头，<token> 位于 chahoutan-tokens.txt 下。

# 获取图片被哪些茶后谈引用
GET /v1/images/{{image-id}}/revisions

# 获取当前茶后谈的所有修订
GET /v1/posts/{{post-id}}/revisions
GET /v1/posts/{{revision-id}}/revisions

私有更新 API：

需添加 Authorization: Bearer <token> 请求头，<token> 位于 chahoutan-tokens.txt 下。

POST /v1/images 的 Content-Type 需为图片格式，DELETE 和 POST /v1/refresh 无需 Content-Type，其他均为 application/json。

# 重新索引已有茶后谈（无需 Content-Type，body 将会被忽略）
POST /v1/refresh

# 上传图片（Content-Type 需为图片格式）
POST /v1/images

# 删除图片（已被某版修订引用的图片无法删除）
DELETE /v1/images/{{image-id}}

# 上传新的茶后谈（创建新修订）
POST /v1/posts

# 删除已有茶后谈（已有修订仍可检索）
DELETE /v1/posts/{{post-id}}

# 修改已有茶后谈的图片（创建新修订）
PUT /v1/posts/{{post-id}}/images

# 修改已有茶后谈的编辑者（历史记录不会保存）
PUT /v1/posts/{{post-id}}/editors