Web function is a new function capability in SCF. Compared with event function that has limits on the event format, web function focuses on optimization of web service scenarios and can directly send HTTP requests to URLs to trigger function execution. For more information, please see Function Overview.
The Serverless Framework SCF component now supports deploying web functions; therefore, you can use it to quickly create and deploy web functions.
Directions
1. Run the following command to initialize the serverless web function template.
sls init http-demo
2. Enter the demo project and view the directory structure as shown below:
. http-demo
├── serverless.yml # Configuration file
├── package.json # Dependency file
├── scf_bootstrap # Project bootstrap file
└── index.js # Service function
Here, scf_bootstrap is the project bootstrap file. For the specific writing rules, please see Bootstrap File Description.
3. Open serverless.yml to view the configuration information.
You only need to add the type parameter in yml to specify the function type and deploy the web function.
Note:
For web functions, there is no need to specify the entry function.
If the type parameter is not entered, the function will be an event function by default.
If there is no scf_bootstrap bootstrap file in the local code, you can specify the entryFile parameter in yml to specify the entry function, and the component will generate a default scf_bootstrap file for you to complete the deployment based on the runtime language. After the deployment is completed, you need to modify the content of the scf_bootstrap file in the SCF console according to the actual needs of your project.
Below is a sample yml file:
component: scf
name: http
inputs:
src:
src: ./
exclude:
- .env
# Specify web type as the function type
type: web
name: web-function
region: ap-guangzhou
runtime: Nodejs12.16
# For Node.js, you can enable automatic dependency installation
installDependency:true
events:
-apigw:
parameters:
protocols:
- http
- https
environment: release
endpoints:
-path: /
method: ANY
4. In the root directory, run sls deploy to complete the service deployment. Below is a sample:
Scheme 1: directly open the output path URL in a browser, and if it can be accessed normally, the function is successfully created, as shown below:
Scheme 2: use other HTTP testing tools such as CURL and Postman to test the web function you have successfully created. Below is a sample test with CURL:
