Serverless Cloud Function
- Release Notes and Announcements
- Product Introduction
- Purchase Guide
- Billable Items and Billing Modes
- SCF Pricing
- User Guide
- Quota Management
- Managing Functions
- Web Function Management
- Concurrence Management
- Trigger Management
- A Custom Domain Name
- Version Management
- Permission Management
- Managing Monitors and Alarms
- Network Configuration
- Layer Management
- Execution Configuration
- Extended Storage Management
- Triggers
- API Gateway Trigger
- Websocket
- COS Trigger
- CLS Trigger
- Timer Trigger
- CKafka Trigger
- Apache Kafka Trigger
- Development Guide
- Developer Tools
- Serverless Cloud Framework
- Calling SDK Across Functions
- Third-Party Tools
- Malagu Framework
- Code Development
- Node.js
- Java
- Custom Runtime
- Deploying Image as Function
- Web Framework Development
- Practical Tutorial
- Business Development
- ServerlessFramework Practices
- API Gateway
- Using API Gateway to Provide API Service
- TRTC Practices
- COS Practices
- Acquire Image on COS and Create a Thumbnail
- MapReduce Method that Uses WordCount as an Example
- CKafka Practice
- CLS
- CLB Practice
- MPS
- Scheduled Task
- Video Processing
- Success Stories
- Online Video Industry
- API Documentation
- Making API Requests
- Function APIs
- Layer Management APIs
- Async Event Management APIs
- Other APIs
- FAQs
- Related Agreement
DocumentationServerless Cloud FunctionPractical TutorialAPI GatewayUsing API Gateway to Provide API ServiceExample
Example
Last updated: 2024-12-02 16:35:34
In this tutorial, suppose that:
You want to use SCF to implement a web backend service, such as querying the articles in a blog and providing the article contents.
You want to use APIs to provide services for webpages and applications.
Implementation Overview
The implementation process of the service is as follows:
Create a function, configure API rules in API Gateway, and point the backend service to the function.
A user sends a request that contains an article ID to the API.
SCF queries the content corresponding to the ID according to the request parameters and responds to the request in JSON format.
The user performs subsequent processing after receiving the response in JSON format.
Note: after going through this tutorial, your account will have the following resources:
An SCF function triggered by API Gateway.
An API service in API Gateway and related API rules.
This tutorial is divided into three parts:
Complete the coding, creation, and testing of a function.
Complete the design, creation, and configuration of an API service and API rules.
Test and verify the correctness of the API through a browser or HTTP request tool.
API Design
The design of APIs for modern applications usually follows the RESTful specification. Therefore, in this example, we design the API for getting blog articles as follows:
/article GET
Return the article list
/article/{articleId} GET
Return the article content based on the article ID
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No