{"componentChunkName":"component---src-templates-best-practice-detail-tsx","path":"/best-practice/2019-12-3-Easy-to-build-REST-API","result":{"data":{"currentBlog":{"id":"1a6791e1-0295-546d-ac0c-c19730a4bac2","frontmatter":{"thumbnail":"https://img.serverlesscloud.cn/2020115/1579074115778-1577347088399-website_fang.png","authors":["liujiang"],"categories":["best-practice"],"date":"2019-12-03T00:00:00.000Z","title":"通过 SCF Component 轻松构建 REST API，再也不用熬夜加班了","description":"本教程将分享如何通过 Serverless SCF Component 、云函数 SCF 及 API 网关组件，快速构建一个 REST API 并实现 GET/PUT 操作。","authorslink":["https://github.com/jiangliu5267"],"translators":null,"translatorslink":null,"tags":["Serverless","Restful"],"keywords":"SCF Component,REST API,构建 REST API,Serverless SCF Component","outdated":null},"wordCount":{"words":99,"sentences":25,"paragraphs":25},"fileAbsolutePath":"/opt/build/repo/content/best-practice/2019-12-3-Easy-to-build-REST-API.md","fields":{"slug":"/best-practice/2019-12-3-Easy-to-build-REST-API/","keywords":["go","python","serverless","spa","serverless","action","student","teacher","Serverless","event"]},"html":"

当一个应用需要对第三方提供服务接口时，REST API 无疑是目前最主流的选择。不过，如果自建 REST API，开发者需要购买虚拟机、配置环境等等，等一切都搞定，可能已经又是一个深夜。

\n

REST API 模板使用 Tencent SCF 组件及其触发器能力，方便的在腾讯云创建，配置和管理一个 REST API 应用。您可以通过 Serverless SCF 组件快速构建一个 REST API 应用，实现 GET/PUT 操作。

\n

\"Serverless\"

\n

1. 安装

\n

安装 Serverless Framework

\n
$ npm install -g serverless
\n

2. 配置

\n

通过如下命令直接下载该例子，目录结构如下：

\n
serverless create --template-url https://github.com/serverless/components/tree/v1/templates/tencent-python-rest-api
\n
.\n├── code\n|   └── index.py\n└── serverless.yml
\n

目前 SCF 组件已支持 v2 版本，因此修改了 serverless.yml 文件，改为以下内容：

\n
# serverless.yml \n\ncomponent: scf \nname: apidemo \norg: test \napp: scfApp \nstage: dev \n\ninputs:\n  name: myRestAPI\n  enableRoleAuth: ture\n  src: ./code\n  handler: index.main_handler\n  runtime: Python3.6\n  region: ap-guangzhou\n  description: My Serverless Function\n  memorySize: 128\n  timeout: 20\n  events:\n      - apigw:\n          name: serverless\n          parameters:\n            protocols:\n              - http\n            serviceName: serverless\n            description: the serverless service\n            environment: release\n            endpoints:\n              - path: /users/{user_type}/{action}\n                method: GET\n                description: Serverless REST API\n                enableCORS: TRUE\n                serviceTimeout: 10\n                param:\n                  - name: user_type\n                    position: PATH\n                    required: 'TRUE'\n                    type: string\n                    defaultValue: teacher\n                    desc: mytest\n                  - name: action\n                    position: PATH\n                    required: 'TRUE'\n                    type: string\n                    defaultValue: go\n                    desc: mytest
\n

查看 code/index.py 代码，可以看到接口的传参和返回逻辑：

\n
# -*- coding: utf8 -*-\n\ndef teacher_go():\n    # todo: teacher_go action\n    return {\n        "result": "it is student_get action"\n    }\n\ndef student_go():\n    # todo: student_go action\n    return {\n        "result": "it is teacher_put action"\n    }\n\ndef student_come():\n    # todo: student_come action\n    return {\n        "result": "it is teacher_put action"\n    }\n\ndef main_handler(event, context):\n    print(str(event))\n    if event["pathParameters"]["user_type"] == "teacher":\n        if event["pathParameters"]["action"] == "go":\n            return teacher_go()\n    if event["pathParameters"]["user_type"] == "student":\n        if event["pathParameters"]["action"] == "go":\n            return student_go()\n        if event["pathParameters"]["action"] == "come":\n            return student_come()
\n

3. 部署

\n

通过 sls deploy 命令进行部署，并可以添加 --debug 参数查看部署过程中的信息

\n

如您的账号未登陆或注册腾讯云，您可以直接通过微信扫描命令行中的二维码进行授权登陆和注册。

\n
$ sls deploy\n\nserverless ⚡ framework\nAction: "deploy" - Stage: "dev" - App: "scfApp" - Instance: "myRestAPI"\n\nFunctionName: myRestAPI\nDescription:  My Serverless Function\nNamespace:    default\nRuntime:      Python3.6\nHandler:      index.main_handler\nMemorySize:   128\nTriggers: \n  apigw: \n    - http://service-jyl9i6mc-1258834142.gz.apigw.tencentcs.com/release/users/{user_type}/{action}\n\n31s › myRestAPI › Success
\n

4. 测试

\n

通过如下命令测试 REST API 的返回情况：

\n
\n

注：如 Windows 系统中未安装 curl，也可以直接通过浏览器打开对应链接查看返回情况

\n
\n
$ curl -XGET http://service-9t28e0tg-1250000000.gz.apigw.tencentcs.com/release/users/teacher/go\n\n{"result": "it is student_get action"}
\n
$ curl -PUT http://service-9t28e0tg-1250000000.gz.apigw.tencentcs.com/release/users/student/go\n\n{"result": "it is teacher_put action"}
\n

5. 移除

\n

可以通过以下命令移除 REST API 应用

\n
$ sls remove --debug\n\n  DEBUG ─ Flushing template state and removing all components.\n  DEBUG ─ Removing any previously deployed API. api-37gk3l8q\n  DEBUG ─ Removing any previously deployed service. service-9t28e0tg\n  DEBUG ─ Removing function\n  DEBUG ─ Request id\n  DEBUG ─ Removed function myRestAPI successful\n\n  7s » myRestAPI » done
\n

查看：操作指南

\n
\n
\n
\n
\n

传送门：

\n\n
\n

欢迎访问：Serverless 中文网，您可以在 最佳实践 里体验更多关于 Serverless 应用的开发！

","tableOfContents":""},"previousBlog":{"id":"74a25989-4611-5393-85ef-698f2c988635","frontmatter":{"thumbnail":"https://img.serverlesscloud.cn/20191226/1577353111488-website.png","authors":["liujiang"],"categories":["best-practice"],"date":"2019-12-04T00:00:00.000Z","title":"Hexo + Serverless Framework，简单三步搭建你的个人博客","description":"简单三步，即可通过 Serverless Website 组件快速构建一个 Serverless Hexo 站点。","authorslink":["https://github.com/jiangliu5267"],"translators":null,"translatorslink":null,"tags":["Serverless","Hexo"],"keywords":"Hexo Serverless,Serverless Website,Serverless Hexo 站点","outdated":true},"wordCount":{"words":146,"sentences":34,"paragraphs":34},"fileAbsolutePath":"/opt/build/repo/content/best-practice/2019-12-4-Quickly-build-personal-blog.md","fields":{"slug":"/best-practice/2019-12-4-Quickly-build-personal-blog/","keywords":["nodejs","serverless","website","website 组件","无服务器","hexo","serverless","Serverless","yml","Hexo","website","tencent"]}},"nextBlog":{"id":"8fb3dfc3-b43e-5c5d-82d2-b4c0809761e3","frontmatter":{"thumbnail":"https://img.serverlesscloud.cn/2020114/1578992366948-16e6e6a4c7f54ffb.png","authors":["腾讯 IVWEB 团队"],"categories":["guides-and-tutorials"],"date":"2019-11-15T00:00:00.000Z","title":"NGW，前端新技术赛场：Serverless SSR 技术内幕","description":"腾讯 IVWeb team（负责腾讯互动视频 NOW 直播、花样直播等产品） 经验分享~","authorslink":["https://juejin.im/user/5a9f77666fb9a028c14a01eb"],"translators":null,"translatorslink":null,"tags":["NGW","Serverless SSR"],"keywords":"Serverless SSR,Serverless 新技术","outdated":null},"wordCount":{"words":582,"sentences":109,"paragraphs":109},"fileAbsolutePath":"/opt/build/repo/content/blog/2019-11-15-serverless-ssr.md","fields":{"slug":"/blog/2019-11-15-serverless-ssr/","keywords":["php","serverless","webpack","服务端渲染","同构渲染","无服务器","云函数","函数","直出","Serverless","serverlesscloud"]}}},"pageContext":{"isCreatedByStatefulCreatePages":false,"blogId":"1a6791e1-0295-546d-ac0c-c19730a4bac2","previousBlogId":"74a25989-4611-5393-85ef-698f2c988635","nextBlogId":"8fb3dfc3-b43e-5c5d-82d2-b4c0809761e3"}}}