什么是 openwhisk-routes?
openwhisk-routes 是一个 Node.js 库,用于在 Apache OpenWhisk 服务器上创建和部署 RESTful API。它提供了一个简单且易于使用的方式来定义和管理 API 的路由和处理程序。
安装和使用 openwhisk-routes
安装
使用 npm 安装 openwhisk-routes。
npm install openwhisk-routes
快速开始
在你的应用程序中,你需要建立一个 openwhisk-routes 实例,然后添加路由,并为每个路由指定一个处理程序。
-- -------------------- ---- ------- ----- --------- - --------------------- ----- ------- - ------------------- ----- --------------- - ---------------------------- ----- --- - ---------- ----- --------------- - ------------ ----- --------------- - --- ----------------- -------- --------- --------------- --- --------------- ------------- --------- -------------- ------------- --------- -------------- --------- -------- -- ----------------- ------ ------------ -- ----------------- --- ---- ------ ---------------- -- -- ------------------------
这个示例向应用程序添加了两个路由,并将它们部署到名为 "my-app" 的 OpenWhisk 应用程序上。路由可以使用 "GET"、"POST"、"PUT" 和 "DELETE" 请求方法创建。
添加 action
上面的示例中使用了 "HelloAction" 和 "WorldAction",需要在 OpenWhisk 中创建它们。
-- -------------------- ---- ------- ----- --------- - --------------------- ----- -------- - -------------------------- ----- -------- - -------------------------- ----- --------------- - ----------- -------- -------------------------- ------------- ----- -- ------ --- ----- ----------- - ----- ------ -- - ----- ---- - ---------- ----- ------- - ------- ---------- ------ - ------- -- -- ----- ----------- - ----- -- -- - ------ - -------- ------- ------- -- -- -------------------------------- ----- -------------- ---------- ---- ----- - ----- ----------- ----- ----------------------- -- --- -------------------------------- ----- -------------- ---------- ---- ----- - ----- ----------- ----- ----------------------- -- ---
创建 Action 后,在应用程序中可以使用它们。
路由
可以使用 openwhiskRoutes.route(method, path, actionName)
方法添加路由。
openwhiskRoutes .route('POST', '/api/items', 'CreateItemAction') .route('GET', '/api/items/:id', 'GetItemAction') .route('PUT', '/api/items/:id', 'UpdateItemAction') .route('DELETE', '/api/items/:id', 'DeleteItemAction');
部署
添加完路由后,可以将配置部署到 OpenWhisk 服务器上。
openwhiskRoutes.deploy() .then(() => console.log('api 部署成功')) .catch((err) => console.error('api 部署失败', err))
完整的示例代码
-- -------------------- ---- ------- ----- --------- - --------------------- ----- ------- - ------------------- ----- --------------- - ---------------------------- ----- --- - ---------- ----- --------------- - ------------ ----- --------------- - --- ----------------- -------- --------- --------------- --- -- --- ------ --------------- ------------- --------- -------------- ------------- --------- -------------- -------------- ------------- ------------------- ------------- ----------------- ---------------- ------------- ----------------- ------------------- ---------------- ----------------- -------------------- -- ------ ------ ------------------------ -------- -- ---------------- ------- ------------ -- ------------------ ------ ------ -- ----- --- --- ---------------- -- -- ------------------------ -- ------ ------- ----- -------- - -------------------------- ----- -------- - -------------------------- ----- --------------- - ----------- -------- -------------------------- ------------- ----- --- ----- ----------- - ----- ------ -- - ----- ---- - ---------- ----- ------- - ------- ---------- ------ - ------- -- -- ----- ----------- - ----- -- -- - ------ - -------- ------- ------- -- -- ----- ---------------- - ----- ------ -- - -- ----- --- -------------- ------ --- -- ----- ------------- - ----- ------ -- - -- ----- --- -------------- ------ --- -- ----- ---------------- - ----- ------ -- - -- ----- --- -------------- ------ --- -- ----- ---------------- - ----- ------ -- - -- ----- --- -------------- ------ --- -- -------------------------------- ----- -------------- ---------- ---- ----- - ----- ----------- ----- ----------------------- -- --- -------------------------------- ----- -------------- ---------- ---- ----- - ----- ----------- ----- ----------------------- -- --- -------------------------------- ----- ------------------- ---------- ---- ----- - ----- ----------- ----- ---------------------------- -- --- -------------------------------- ----- ---------------- ---------- ---- ----- - ----- ----------- ----- ------------------------- -- --- -------------------------------- ----- ------------------- ---------- ---- ----- - ----- ----------- ----- ---------------------------- -- --- -------------------------------- ----- ------------------- ---------- ---- ----- - ----- ----------- ----- ---------------------------- -- ---
总结
openwhisk-routes 是一个非常有用的 Node.js 库,它可以使创建和管理 API 变得更加简单和高效。通过这个库,您可以快速地添加路由和处理程序,并将配置部署到 OpenWhisk 服务器上。本文中提供了一个完整的示例,您可以根据自己的需求来使用和修改它。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60055e6481e8991b448dbc83