nodebb-plugin-thesis-write-api
Advanced tools
Readme
Plugin được chỉnh sửa dựa trên source code gốc của nodebb-plugin-write-api Plugin cung cấp các REST api để thao tác lên cơ sở dữ liệu của server chạy NodeBB
npm linknpm link nodebb-plugin-thesis-write-apiChứng thực được xử lý thông qua cả HTTP Bearer hoặc là JSON Web Token
Có hai loại tokens
user token liên hệ trực tiếp đến uid của người dùng được cấp cho token (thông qua trang admin của plugin này), mọi thao tác đều thực hiện trên danh nghĩa username của người dùng này
master token không liên hệ phụ thuộc với bất kỳ người dùng nào, vì vậy cần truyền tham số _uid trong request gửi lên server, sau đó các thao tác sẽ được thực hiện dưới tên của người dùng này.
Đây là khác biệt cơ bản giữa 2 loại tokens. Những master token nếu chứa tham số _uid chưa được trao quyền admin sẽ không thực hiện được các thao tác cần quyền admin này.
Chú ý: user token có thể được tạo thông qua trang administration(admin/plugins/thesis-write-api), or via the token generation route (POST /api/v1/users/{UID}/tokens) bằng cách gửi kèm password, thêm vào đó user tokens có thể được tạo từ những master token đã có sẵn.
Để thực hiện request với JSON Web Token thay vì user/master token, thêm vào request payload với biến secret như được định nghĩa ở trang admin của plugin, ngoài ra cũng phải gửi kèm nó trong POST body, hoặc trong query string parameter. Ở cả hai trường hợp, key token đều được sử dụng.
Ví dụ
$ curl http://localhost:4567/api/v1/users/1/tokens?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJfdWlkIjoxfQ.pbm5wbAZ4__yFh5y8oeCsJyT0dm8ROcd5SEBr4yGlNw # secret là 'secret'
Khi API gặp lỗi, chương trình sẽ báo lỗi. Các lỗi sẽ được báo thông qua format bên dưới:
{
"code": "not-authorised",
"message": "You are not authorised to make this call",
"params": {}
}
api/dealbee Endpoints/api/dealbee
/users
POST /login
username, passwordGET /:uid
GET /:uid/topics
uidlimit, offsetPOST /
usernamepassword, emailPUT /:uid
username, email, fullname, website, location, birthday, signatureaction:user.updateProfile hook đều được chấp nhậnuid có thể không cần thiết trong request body. Không có nó, profile của người dùng đang được gọi sẽ được cập nhật.DELETE /:uid
PUT /:uid/password
uid, newcurrentcurrent cần phải có nếu người dùng gọi requets này không phải là administratorPOST /:uid/follow
DELETE /:uid/follow
POST /:uid/chats
messagetimestamp, quiettimestamp (unix timestamp in ms) cho phép các tin nhắn được gửi từ quá khứ (tiện dụng để import chat)quiet nếu được set, sẽ không thông báo đến người dùng nếu tin nhắn đến (sử dụng khi import chat)POST /:uid/ban
DELETE /:uid/ban
GET /:uid/tokens
POST /:uid/tokens
password in lieu of Bearer tokenpassword trong request body. Tạo một token mới và sử dụng token đó trong những lần gọi sau.DELETE /:uid/tokens/:token
*Xóa token tương ứng của người dùng
/categories
GET /
POST /
namedescription, bgColor, color, parentCid, classPUT /:cid
name, description, bgColor, color, parentCidDELETE /:cid
PUT /:cid/state
DELETE /:cid/state
/groups
POST /
namedescription, hidden, private, ownerUidDELETE /:slug
POST /:slug/membership
DELETE /:slug/membership
/topics
GET /
sorted phương thức sort, bao gồm:
cid id của chủ đề cần lọcflashdeal chỉ lấy flashdeal trong vòng 24H (true hay false)limit đi kèm cùng offset để phân trangGET /:tid
tidtid, bao gồm thông tin chi tiết của main post, chứa ở trường mainPostGET /:tid/posts
../topics/1/posts?limit=2&offset=1limit (default 5), offsetPOST /
cid, title, content, _uid của người tạotags (array),amount kiểu int,brand,coupon,currency phải hợp lệ,dealUrl,price kiểu float,discountPercentage kiểu float <=100,discountPrice kiểu float,expiredAte chuỗi milisecond,maxDiscount kiểu float,minOrder kiểu int,thumb,skuPOST /:tid
contenttoPidPUT /:tid
pid, contenthandle, title, topic_thumb, tagsDELETE /:tid
POST /:tid/follow
DELETE /:tid/follow
POST /:tid/tags
tagsDELETE /:tid/tags
/pinned-topics
GET /
_key có dạng pindealbee:{area id}:{position id}/posts
POST /
uid (người đăng comment), tid (topic được comment), contenttimestamp chuỗi milisecondPUT /:pid
contenttitle, topic_thumb, tagsDELETE /:pid
POST /:pid/vote
piddelta, uid người votedelta là một con số. Nếu delta > 0, thì được xem là upvotes, nếu delta < 0, thì được xem là downvotes, còn lại là unvote.DELETE /:pid/vote
uid của người unvote/util
POST /uploadfiles[]FAQs
Write-enabled API for NodeBB
The npm package nodebb-plugin-thesis-write-api receives a total of 8 weekly downloads. As such, nodebb-plugin-thesis-write-api popularity was classified as not popular.
We found that nodebb-plugin-thesis-write-api demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Socket CEO Feross Aboukhadijeh joins a16z partners to discuss how modern, sophisticated supply chain attacks require AI-driven defenses and explore the challenges and solutions in leveraging AI for threat detection early in the development life cycle.
Security News
NIST's new AI Risk Management Framework aims to enhance the security and reliability of generative AI systems and address the unique challenges of malicious AI exploits.
Security News
This episode of the Risky Biz podcast discusses how the rise of small open source packages and the shift towards individual maintainers makes the ecosystem more vulnerable to supply chain attacks.