No description
  • Go 96.3%
  • HTML 3.7%
Find a file
小满1221 4ae7340074 docs: 添加项目 README 文档
- 创建项目介绍文档,包含功能特性和技术栈说明
- 添加快速开始指南和 API 接口使用说明
- 补充配置说明和开发文档
- 提供项目结构说明和数据模型介绍
2026-03-20 11:50:12 +08:00
.idea refactor(main): 将结构体定义移至entity包并更新引用 2026-03-20 11:01:40 +08:00
entity refactor(main): 将结构体定义移至entity包并更新引用 2026-03-20 11:01:40 +08:00
sentences Init Commit 2026-03-20 09:30:59 +08:00
wwwroot Init Commit 2026-03-20 09:30:59 +08:00
.env refactor(main): 重构项目结构并添加句子包管理功能 2026-03-20 11:44:11 +08:00
go.mod Init Commit 2026-03-20 09:30:59 +08:00
go.sum Init Commit 2026-03-20 09:30:59 +08:00
Handlers.go refactor(main): 重构项目结构并添加句子包管理功能 2026-03-20 11:44:11 +08:00
libs.go refactor(main): 重构项目结构并添加句子包管理功能 2026-03-20 11:44:11 +08:00
main.go refactor(main): 重构项目结构并添加句子包管理功能 2026-03-20 11:44:11 +08:00
README.md docs: 添加项目 README 文档 2026-03-20 11:50:12 +08:00

HitokotoGo

一言Hitokoto句子服务 Go 语言实现,提供随机句子 API 接口。

项目简介

HitokotoGo 是一个基于 Go 语言开发的一言句子服务,从 hitokoto.cn 获取句子数据,并提供 HTTP API 接口供前端调用。

功能特性

  • 🚀 快速启动,基于 Go 1.26
  • 📦 自动下载和缓存句子数据
  • 🔄 支持按分类获取句子
  • 🌐 提供 HTTP API 接口
  • 🔧 支持环境变量配置

项目结构

HitokotoGo/ 
├── entity/ # 数据模型定义 
│ └── Sentences.go # 句子相关结构体 
├── sentences/ # 句子数据缓存目录 
├── wwwroot/ # 静态文件目录 
│ └── index.html # 首页 
├── .env # 环境变量配置 
├── go.mod # Go 模块依赖 
├── main.go # 主程序入口 
└── README.md # 项目文档

快速开始

环境要求

  • Go 1.26 或更高版本

安装步骤

  1. 克隆项目

  2. 安装依赖

  3. 访问服务

打开浏览器访问:http://localhost:8000

API 接口

获取随机句子

接口地址: POST /v2

请求参数:

  • key (可选): 句子分类 key默认为 a

示例:

句子分类

支持的分类 key 包括:

  • a - 动画
  • b - 漫画
  • c - 游戏
  • d - 文学
  • e - 原创
  • f - 来自网络
  • g - 其他
  • h - 影视
  • i - 诗词
  • j - 网易云
  • k - 哲学
  • l - 历史

配置说明

变量名 说明 默认值
HOST 服务器监听地址 0.0.0.0
PORT 服务器端口 8000
BASE_URL 句子数据源地址 https://sentences-bundle.hitokoto.cn

开发说明

数据结构

项目使用的主要数据结构定义在 entity/Sentences.go 中:

  • SentencesSimple: 句子简化模型
  • SentencesVersion: 句子版本信息
  • SentencesCategories: 句子分类信息

自动更新

程序首次运行时会自动从 sentences-bundle.hitokoto.cn 下载句子数据到 sentences/ 目录,后续运行会直接读取本地缓存。

技术栈

  • 语言: Go 1.26
  • Web 框架: Go 标准库 net/http
  • 依赖管理: Go Modules
  • 第三方库:
    • github.com/joho/godotenv - 环境变量管理

许可证

本项目遵循开源协议。

致谢

问题反馈

如有问题或建议,欢迎提交 Issue。