该项目是 bmybbs 项目的 API 部分。
API 是一个纯 C 编写的 HTTP 服务器,并采用 JSON 格式输出。其依赖如下的库
- Onion - 一个用 C 开发的 HTTP 框架。
- json-c - 一个用 C 开发的 JSON 库。
- libxml2 - xml 解析器,Gnome 项目的一部分。
- libytht
- libythtbbs
仓库中的代码主要分为两部分,业务处理以及库函数。前者直接处理 URL 请求和响应,后者向前者提供支持。库的部分包括
api_template.c api_brc.c apilib.c
注意 Makefile
中链接以及 bmybbs 引用的位置,并请先编译安装 bmybbs。完成后,可以执行:
$ make
$ ./bmyapi > api.log 2>&1 &
接口文档托管在 readthedocs.org,请访问 http://bmybbs-api-docs.readthedocs.org/
若接口返回的 errcode
字段不为 0,请参见 错误码列表。使用中若有其他问题,请至 bmybbs BMY_Dev 版面或者 Issue 列表提出。