简介
npm 包 suren-restful 是一个方便前端开发的 RESTful API 封装库。使用该库可以简化前端调用 RESTful API 的过程,减少重复代码以及增加代码可读性和可维护性。
安装
使用 npm 进行安装:
npm install suren-restful
使用方法
引入库并初始化
在页面中引入库,并且初始化:
import Restful from 'suren-restful'; const restful = new Restful({ baseURL: 'https://api.example.com' });
初始化时,需要传入服务端的 baseURL。其他可选的参数包括 headers、timeout 等,具体可以参考 axios 的文档。
GET 请求
以获取所有文章为例:
restful.get('/articles') .then(response => { console.log(response.data); }) .catch(error => { console.error(error); });
POST 请求
以创建一篇新文章为例:
-- -------------------- ---- ------- ------------------------- - ------ ---- --------- -------- ----- -- - --- --------- -- -------------- -- - --------------------------- -- ------------ -- - --------------------- ---
PUT 请求
以更新一篇文章为例:
-- -------------------- ---- ------- -------------------------- - ------ -------- --------- -------- ----- ------- --- ---- --------- -- -------------- -- - --------------------------- -- ------------ -- - --------------------- ---
DELETE 请求
以删除一篇文章为例:
restful.delete('/articles/1') .then(response => { console.log(response.data); }) .catch(error => { console.error(error); });
请求拦截
使用请求拦截可以对每个请求进行统一处理,比如添加 token。
-- -------------------- ---- ------- --------------------------------------- -- - ----- ----- - ------------------------------ -- ------- - ------------------------------- - ------- ---------- - ------ ------- -- ----- -- - ------ ---------------------- ---
响应拦截
使用响应拦截可以对每个响应进行统一处理,比如处理错误信息。
-- -------------------- ---- ------- ------------------------------------------ -- - ------ --------- -- ----- -- - ----- -------- - --------------- -- ---------------- --- ---- - -- -------- - ---- -- ---------------- --- ---- - -- ---------- - ---- - -- ------ - ------ ---------------------- ---
总结
npm 包 suren-restful 简化了前端调用 RESTful API 的过程,减少了重复代码并提高了代码可读性和可维护性。使用拦截器可以对请求和响应进行统一处理,更进一步提高了开发效率。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6005671c81e8991b448e37a1