https://github.com/notadd/nt-module-cms
The cms module for Notadd application.
https://github.com/notadd/nt-module-cms
Last synced: about 1 year ago
JSON representation
The cms module for Notadd application.
- Host: GitHub
- URL: https://github.com/notadd/nt-module-cms
- Owner: notadd
- License: apache-2.0
- Archived: true
- Created: 2018-10-17T07:11:12.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-05-11T11:46:08.000Z (about 7 years ago)
- Last Synced: 2024-11-13T04:52:06.584Z (over 1 year ago)
- Language: TypeScript
- Size: 613 KB
- Stars: 12
- Watchers: 5
- Forks: 4
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Notadd CMS模块(Grpc 版本)
## 功能
- [x] 文章管理
- [x] 文章分类管理
- [x] 系统消息管理
## 使用说明
在应用程序中的GRPC客户端文件中注入CMS模块并导入proto文件,使用GRPC通信,再由客户端提供Graphql接口即可调用CMS模块的所有接口。
CMS模块目前所有接口均无限制,如需要权限限制，可以参考用户中心模块的资源定义及权限定义。(https://github.com/notadd/nt-module-user/blob/graphql-api/README_zh.md)
##接口说明
当前版本CMS模块提供了管理功能所需的基本接口，以下介绍常用的接口逻辑
### 文章分类
- `AddClassify` 添加文章分类
- `DelClassify` 删除指定分类
- `UpdateClassify` 更新指定分类信息
- `GetAllClassify` 获得所有分类
> tip:系统已自动创建了一个最顶级分类即总分类,再创建分类时上级分类id传1即可。
### 文章
- `CreateArticle` 添加文章
- `UpdateArticle` 修改文章
- `RecycleArticleByIds` 将指定文章放入回收站
- `DeleteArticleByIds` 将回收站中指定文章永久删除
- `RecoverArticleByIds` 将回收站中指定文章恢复
- `AuditArticle` 审核文章
- `GetAllArticle` 查看所有文章
- `GetArticleById` 查看指定文章
### 消息通知
- `CreateMessage` 创建消息
- `DeleteMessageById` 批量删除指定消息
- `GetAllMessage` 查看所有消息