开发者须知 | for developer & api document

[shinnku]

警告️: 这则帖子不是给非开发者观看
论坛食用 & 规则贴参考此篇文章: https://bbs.shinnku.com/topic/101

[shinnku]

1. Forum structure (论坛架构)

https://galgame.dev/ is powered by Node.js and Redis, It utilizes web sockets for instant interactions and real-time notifications. It takes the best of the modern web by using Socks .io: real-time streaming discussions, mobile responsiveness, and rich RESTful read/write APIs, while staying true to the original bulletin board/forum format → categorical hierarchies, local user accounts, and asynchronous messaging.

Cloudflare CDN <-> mutipule Nginx web servers <-> Forum clusters <-> Redis cluster with S3 for Image Storage.

[shinnku]

Authentication

There are a multitude of ways to authenticate.

Cookie Authentication

By default, the API will attempt to find a valid session in the browser's cookies. A valid login session is required for API calls that pertain to operations involving a logged-in user.
For example, /api/unread is a route showing unread topics, and is not accessible by guest users. Most data transfer utilities like cURL will allow you to construct something like a cookie, to be sent alongside the request, to function much like a browser cookie. This should work with the API.

Bearer Authentication

Both the Read API and Write API offer bearer authentication, as administered through the administration panel.

[yurzhang]

It looks like this topic is no longer being updated.
For those who want to use the API, basically check these two API documents:

• NodeBB Read API
• NodeBB Write API