观星记开发文档

感谢您参与观星记开发！观星记始终秉承开放开源共享的态度，希望与大家共同分享我们的源代码与API。我们会根据自身的策略，逐步公开我们的源码、API及其使用指导。

技术基底

观星记Starte PC是一款基于Electron的软件，目前仅提供Windows版，这是因为一键设置壁纸功能仅支持Windows端。从0.4.0版本开始，观星记使用的各依赖项的版本如下：

依赖项	版本
electron	28.2.2
electron-builder	24.9.1
axios	1.2.2
form-data	4.0.0
node-machine-id	1.1.12
v8-compile-cache	2.3.0

本项目使用 PNPM 作为包管理器。 开发者使用 node.js 18 并克隆本仓库的源代码到本地，并运行pnpm install以安装所有需要的依赖项。

版本号命名

从v0.4.1版本开始，观星记采取新的版本号命名方式：

• 所有版本号均以v开头
• 主版本号：主要用于标识软件整体重写或不向后兼容的改变。当软件有重大变更时，主版本号递增，次版本和修订号清零。例如，从版本号1.9.1升级到2.0.0
• 次版本号：用于标识功能更新或增加功能。主版本号不变，次版本号递增，修订号清零。例如，从版本号1.5.1升级到1.6.0
• 修订号：用于标识Bug修复发布。主版本号和次版本号不变，修订号递增。例如，从版本号1.5.0升级到1.5.1

今后不再在版本号中标注“beta”字样和发布日期，也不标注构建次数、送测版本号等。

API

由于观星记所使用的图片均来自互联网，秉承着互联网开放共享的原则，观星记愿意并且应当公开自己的API，并认为这才是真正的互联网精神。从v0.4.2版本开始，观星记的可公开API如下，其中{id}是从0开始的整数：

• 获取today图片：https://api.zestela.co/new-mainpage/get-mainpage.php
• 获取往日图片：https://api.zestela.co/new-mainpage/get-mainpage-history-list.php
• 根据id获取图片：https://api.zestela.co/new-mainpage/get-photo-title-describe-links.php?id={id}
• 获取观星句子：https://api.zestela.co/new-book/new-get-book-sentence-list.php
• 获取包括今日图片在内的过去图片列表：https://api.zestela.co/new-book/new-get-mainpage-list.php
• 获取沧溟文章列表：https://api.zestela.co/vicissitudes/vicissitudes.php
• 根据id获取沧溟文章详情：https://api.zestela.co/vicissitudes/get-vici-by-id.php?id={id}
• 获取最新版本：https://api.zestela.co/banben.json

除了以上的公开API以外，开发者不得使用观星记源代码中任何没有展示在上述列表中的其他API。滥用API是不能容忍的，这是对观星记服务器资源的非法侵占。如果有人妄图利用API从事刷流量、上传非法或误导性数据、破坏后台数据库结构等严重侵犯观星记财产权益的行为，我们有权采用一切手段维护自身合法权利。

观星记提供的API返回均为json格式。一般地，开发者可以通过fetch或axios等方式来获取API并提取其中的json。