kms-midway

介绍

基于Midway框架的PKMS接口服务，提供PKMS接口服务，目前包括用户管理、分类管理、书签管理、关键词管理等。后续将规划增加知识图谱，知识库管理等功能。

软件架构

软件架构说明

TODO: 状态码返回问题，当前实现仅返回success，成功或失败

• 一种实现是http状态吗不需要在响应数据中返回，而应根据http的状态码来判断，后端在产生异常时应主动抛出对应类型的异常；
• 另一种实现是在响应数据中增加status或code字段，表示当前请求的状态，成功或失败，但这样与http状态码重复，似乎并不满足Restfull API风格要求。

REST API 状态码（HTTP Status Code）是用以标识请求处理的结果的一种机制。它们遵循一定的规范，用以表示请求的成功程度。以下是一些常见的状态码及其含义：

200 OK：请求已成功，且有 body 数据返回。
201 Created：请求已成功，并因此创建了一个新的资源。
204 No Content：请求已成功，但没有内容返回。
400 Bad Request：请求格式错误或无法处理请求。
401 Unauthorized：请求需要用户验证。
403 Forbidden：请求已经得到验证，但是访问是被禁止的。
404 Not Found：服务器无法找到请求的资源。
405 Method Not Allowed：请求行中的方法不允许对请求 URL 使用。
415 Unsupported Media Type：请求的格式不支持。
500 Internal Server Error：服务器遇到了意料之外的情况，不能完成请求。
503 Service Unavailable：服务器暂时不可用（可能是过载或维护）。

commit message格式

格式：git commit -m "[type] XXXX模块（XXXXX功能）"
示例：git commit -m "fix XXXX模块（XXXXX功能）"

Type：必选项，取值如下：

● init：初始化
● feat：新功能（feature）
● directory：工程目录调整
● build：构建工具
● dev：功能开发（feature development）
● fix：修补bug
● update：更新相对独立的外部(第三方)文件或代码引用
● delete：删除无效代码或文件
● docs：文档修改（documentation）
● style：格式（不影响代码运行的变动）
● change：指需求变更引发的调整
● optimize：优化代码（指程序员主动改善性的优化，非bug，非重大或颠覆性的调整）
● refactor：重构（对已有功能的重大或颠覆性的调整，非新增功能）
● merge：合并代码（代码冲突时，须注明冲突点）
● test：增加测试
● chore：构建过程、辅助工具的变动
● revert：用于撤销以前的 commit。（特殊情况）

环境配置

数据库

host: 'localhost',
port: 3306,
username: 'kms_midway',
password: 'kms_midway',
database: 'kms_midway',

安装&使用说明

# midway quick guide sample
$ npm i
$ npm run dev
$ npm run test