npm 包 @crowdmed/js-sdk 使用教程
介绍
@crowdmed/js-sdk 是一款专为前端开发者打造的 JavaScript SDK，旨在为开发者提供便捷的调用 CrowdMed API 的方式。它支持浏览器端和 Node.js 环境下使用，可以帮助开发者快速地将 CrowdMed API 集成到自己的项目中。
安装
在使用 @crowdmed/js-sdk 前，需要确保已经安装 Node.js，然后通过 npm 安装该包。可以在命令行输入如下命令：
npm install @crowdmed/js-sdk --save
快速开始
首先，需要引入 @crowdmed/js-sdk 并初始化配置。
import CrowdMedJS from "@crowdmed/js-sdk";
const crowdmed = new CrowdMedJS({
apiKey: YOUR_API_KEY,
apiSecret: YOUR_API_SECRET,
endpoint: "https://api.crowdmed.com",
});在这个例子中，你需要替换 YOUR_API_KEY 和 YOUR_API_SECRET 为你自己的 API Key 和 API Secret。
以下是一些示例，展示了如何使用 @crowdmed/js-sdk 调用 CrowdMed API。
获取病人上传的所有文件
crowdmed.getPatientFiles(patientId).then((response) => {
console.log(response.data);
});添加一个新的病例
-- -------------------- ---- -------
----- ------- - -
-------- -
----------- ----
---------- ----
---- ---
------- -------
------ -----------------------
------------- --------------
--
--------- -
-
----- -----
------- ---------
------------------- -----
--
-
----- ------
------- -----------
------------------- ------
--
--
--
-------------------------------------------- -- -
---------------------------
---获取某个病例的详细信息
crowdmed.getCaseDetails(caseId).then((response) => {
console.log(response.data);
});深入学习
初始化配置
在上文中，我们提到了需要先初始化 @crowdmed/js-sdk 的配置。除了 apiKey 和 apiSecret 之外，你还可以进行其他配置，如下：
endpoint：API endpoint 地址，默认值为"https://api.crowdmed.com"timeout：请求超时时间，默认值为30000millisecondsheaders：自定义请求头，可以用来添加 Authorization 头部等
-- -------------------- ---- ------- ----- ------- - - ------- --------------- ---------- ------------------ -------- ----- -------- - -------------- ------- ------------------ -- --------- --------------------------- -- ----- -------- - --- --------------------
调用 CrowdMed API
@crowdmed/js-sdk 提供了方便的接口调用方法，可以直接调用 CrowMed API。下面我们详细介绍几个常用的接口。
getPatientFiles(patientId)获取病人上传的所有文件。参数
patientId表示病人的 ID。addNewCase(case)添加一个新的病例。参数
case是一个包含病人信息、症状信息等的对象。getCaseDetails(caseId)获取某个病例的详细信息。参数
caseId表示病例的 ID。getDiagnoses(caseId)获取某个病例的所有诊断结果。参数
caseId表示病例的 ID。
更多接口可以在官方文档中查看。
错误处理
在使用 @crowdmed/js-sdk 时，你需要注意错误处理。@crowdmed/js-sdk 的接口调用方法返回的是 Promise。如果发生错误，会抛出 CrowdMedJSError 异常。你可以使用 try-catch 捕获这个异常并处理。
try {
const diagnoses = await crowdmed.getDiagnoses(caseId);
} catch (error) {
console.error(error.message);
}结束语
本文介绍了如何使用 @crowdmed/js-sdk 快速调用 CrowdMed API，并给出了一些示例代码。通过深入学习，你可以更好地使用它，并处理错误。我们希望这篇文章对你有所帮助，欢迎试用 @crowdmed/js-sdk。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60065f80238a385564ab6b48