Shulou(Shulou.com)05/31 Report--

Editor to share with you how to easily build REST API through SCF Component, I believe most people do not know much about it, so share this article for your reference, I hope you can learn a lot after reading this article, let's go to know it!

When an application needs to provide a service interface to a third party, REST API is undoubtedly the most mainstream choice. However, if you build your own REST API, developers need to buy virtual machines, configure the environment, and so on, and when everything is done, it may be late at night.

All these can be solved with Serverless Framework. This tutorial will share how to quickly build a REST API and implement GET/PUT operation through Serverless SCF Component, cloud function SCF and API gateway components.

Rapid construction of REST API1. Installation

Install Serverless Framework

$npm install-g serverless2. Configuration

Download the example directly with the following command, and the directory structure is as follows:

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

Looking at the code/index.py code, you can see the passing parameters and return logic of the interface:

#-*-coding: utf8-*-def teacher_go (): # todo: teacher_go action return {"result": "it is student_get action"} def student_go (): # todo: student_go action return {"result": "it is teacher_put action"} def student_come (): # todo: student_come action return {"result": "it is Teacher_put action "} def main_handler (event Context): print (str (event)) if event ["pathParameters"] ["user_type"] = "teacher": if event ["pathParameters"] ["action"] = "go": return teacher_go () if event ["pathParameters"] ["user_type"] = "student": if event ["pathParameters"] ["action"] = "go": return student_go () If event ["pathParameters"] ["action"] = = "come": return student_come () 3. Deployment

Deploy through the sls command, and you can add the-- debug parameter to view the information in the deployment process

If your account is not logged in or registered with Tencent Cloud, you can log in and register directly through the QR code in the command line scanned by Wechat.

Serverless-- debug DEBUG ─ Resolving the template's static variables. DEBUG ─ Collecting components from the template. DEBUG ─ Downloading any NPM components found in the template. DEBUG ─ Analyzing the template's components dependencies. DEBUG ─ Creating the template's components graph. DEBUG ─ Syncing template state. DEBUG ─ Executing the template's components graph. DEBUG ─ Compressing function myRestAPI file to / Users/dfounderliu/Desktop/restAPI/component/.serverless/myRestAPI.zip. DEBUG ─ Compressed function myRestAPI file successful DEBUG ─ Uploading service package to cos [sls-cloudfunction-ap-singapore-code]. Sls-cloudfunction-default-myRestAPI-1574856533.zip DEBUG ─ Uploaded package successful / Users/dfounderliu/Desktop/restAPI/component/.serverless/myRestAPI.zip DEBUG ─ Creating function myRestAPI DEBUG ─ Updating code... DEBUG ─ Updating configure... DEBUG ─ Created function myRestAPI successful DEBUG ─ Setting tags for function myRestAPI DEBUG ─ Creating trigger for function myRestAPI DEBUG ─ Starting API-Gateway deployment with name myRestAPI.serverless in the ap-singapore region DEBUG ─ Service with ID service-ibmk6o22 created. DEBUG ─ API with id api-pjs3q3qi created. DEBUG ─ Deploying service with id service-ibmk6o22. DEBUG ─ Deployment successful for the api named myRestAPI.serverless in the ap-singapore region. DEBUG ─ Deployed function myRestAPI successful myRestAPI: Name: myRestAPI Runtime: Python3.6 Handler: index.main_handler MemorySize: 128Timeout: 20 Region: ap-singapore Role: QCS_SCFExcuteRole Description: My Serverless Function APIGateway:-serverless-http://service-ibmk6o22-1250000000.sg.apigw.tencentcs.com/release 10s > myRestAPI > done4. test

Test the return of REST API with the following command:

Note: if curl is not installed in the Windows system, you can also directly open the corresponding link through the browser to check the return.

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

You can remove the REST API application with the following command

Sls remove-- debug DEBUG ─ Flushing template state and removing all components. DEBUG ─ Removing any previously deployed API. Api-37gk3l8q DEBUG ─ Removing any previously deployed service. Service-9t28e0tg DEBUG ─ Removing function DEBUG ─ Request id DEBUG ─ Removed function myRestAPI successful 7s »myRestAPI »done account configuration (optional)

CLI scanning QR code login is supported by default. If you want to configure persistent environment variable / key information, you can also create .env files locally.

$touch .env # configuration information of Tencent Cloud

Configure Tencent Cloud SecretId and SecretKey information in .env file and save it

If you don't have a Tencent Cloud account, you can register a new account here.

If you already have a Tencent Cloud account, you can obtain SecretId and SecretKey in API key management.

# .envTENCENT _ SECRET_ID=123TENCENT_SECRET_KEY=123 above is all the content of this article "how to easily build REST API through SCF Component". Thank you for reading! I believe we all have a certain understanding, hope to share the content to help you, if you want to learn more knowledge, welcome to follow the industry information channel!

Welcome to subscribe "Shulou Technology Information " to get latest news, interesting things and hot topics in the IT industry, and controls the hottest and latest Internet news, technology news and IT industry trends.