Edge Computing with Cloudflare Workers & Deno · 课时

设计 RESTful API

规划并构建适合边缘部署的 RESTful API 端点、方法和数据模型

第 1 / 3 课11 个步骤

设计 RESTful API 是 CoddyKit 上的免费 Edge Computing with Cloudflare Workers & Deno 课时。这是第 1 节课，共 3 节。你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。这是 Edge Computing with Cloudflare Workers & Deno 学习路径的一部分，你的进度在网页和 CoddyKit 应用中同步。 Edge Computing with Cloudflare Workers & Deno 课程共包含 3 节课。

本课时的部分内容尚未翻译，以英文显示。

Intro to RESTful APIs

Welcome! In this lesson, you'll learn about RESTful APIs, a fundamental way to design web services. REST stands for Representational State Transfer.

Think of an API as a menu in a restaurant. You make a request (order food), and the kitchen (server) sends back a response (your meal). REST defines a set of rules for how this communication should happen over the internet.

Core REST Principles

RESTful APIs are built around a few core ideas:

Resources: Everything is a 'resource' (e.g., a user, a product).
Unique URIs: Each resource has a unique address (a URL or URI).
Standard Methods: HTTP methods (GET, POST, PUT, DELETE) are used to perform actions on resources.
Statelessness: Each request from a client to a server must contain all the information needed to understand the request. The server doesn't store client 'session' state between requests.

Resources Are Nouns

When designing your API, think about the 'things' your application manages. These 'things' are your resources.

For example, if you're building an e-commerce API, your resources might include:

/products
/users
/orders
/categories

Notice how these are all plural nouns. This is a common and recommended practice in RESTful design.

HTTP Methods: The Verbs

HTTP methods tell the server what kind of action you want to perform on a resource. They are like verbs in a sentence:

GET: Retrieve data (e.g., get a product, get a list of users).
POST: Create new data (e.g., create a new user, add a new product).
PUT: Update existing data (replaces an entire resource).
PATCH: Partially update existing data (updates specific fields of a resource).
DELETE: Remove data (e.g., delete a product).

GET: Fetching Data Example

The GET method is used to request data from a specified resource. It should never have side effects (i.e., it shouldn't change data on the server).

Try running this simple Deno server. Then open your browser to http://localhost:8000/products to see the output.

import { serve } from "https://deno.land/std/http/server.ts";

serve(async (req) => {
  const url = new URL(req.url);

  if (req.method === "GET" && url.pathname === "/products") {
    const products = [
      { id: 1, name: "Wireless Mouse", price: 25.99 },
      { id: 2, name: "Mechanical Keyboard", price: 79.99 }
    ];
    return new Response(JSON.stringify(products), {
      headers: { "Content-Type": "application/json" }
    });
  }

  return new Response("Not Found", { status: 404 });
}, { port: 8000 });

console.log("Server running on http://localhost:8000");

POST: Creating Data Example

The POST method is used to submit an entity to the specified resource, often causing a change in state or the creation of a new resource.

This example shows how a Deno server can handle a POST request to create a new product. You would typically send JSON data in the request body.

import { serve } from "https://deno.land/std/http/server.ts";

serve(async (req) => {
  const url = new URL(req.url);

  if (req.method === "POST" && url.pathname === "/products") {
    try {
      const newProduct = await req.json();
      // In a real application, you'd save newProduct to a database.
      // For this example, we'll just log it and return a mock ID.
      console.log("Received new product:", newProduct);
      return new Response(JSON.stringify({ ...newProduct, id: 3 }), {
        status: 201, // 201 Created
        headers: { "Content-Type": "application/json" }
      });
    } catch (e) {
      return new Response("Invalid JSON payload", { status: 400 });
    }
  }

  return new Response("Method Not Allowed", { status: 405 });
}, { port: 8000 });

console.log("Server running on http://localhost:8000");

Designing Endpoint Paths

Clear and consistent endpoint paths (URIs) are crucial for a good API. Here are some best practices:

Use plural nouns: /users, not /user.
Avoid verbs in paths: /products is good, /getProducts is not. The HTTP method implies the action.
Nesting for relationships: For related resources, use nesting. E.g., /users/{id}/orders to get orders for a specific user.
Use path parameters for specific resources: /products/{id} to refer to a single product.

Data Models & Payloads

The data you send to and receive from your API is called a payload. In modern RESTful APIs, JSON (JavaScript Object Notation) is the standard format.

A data model defines the structure of this JSON. For example, a 'product' data model might look like this:

{
  "id": 123,
  "name": "Example Product",
  "description": "A great item.",
  "price": 19.99
}

Consistency in your data models makes your API predictable and easier to use.

RESTful APIs at the Edge

RESTful API design is particularly well-suited for edge computing environments like Cloudflare Workers:

Statelessness: Edge functions are often short-lived and don't maintain state, aligning perfectly with REST's stateless principle.
Caching: GET requests are easily cacheable by CDNs, which is a core benefit of edge computing for reducing latency.
Distributed Nature: REST's clear separation of concerns and uniform interface makes it easier to distribute logic across many edge locations.

API Design Check

You're building an API for a blog. You need to retrieve a list of all blog posts. Which of the following API endpoint designs and HTTP methods is the most RESTful?

在交互式课程中回答

Recap: RESTful API Design

Great job! You've learned the fundamentals of designing RESTful APIs:

APIs use resources (nouns) and HTTP methods (verbs) for communication.
Common methods are GET (retrieve), POST (create), PUT/PATCH (update), and DELETE (remove).
Endpoint paths should be clear, using plural nouns and avoiding verbs.
JSON is the standard format for data payloads.
REST's principles make it an excellent choice for edge computing due to statelessness and cacheability.

Next, we'll dive into input validation and security for your edge APIs!

免费开始

用 AI 导师学习 Edge Computing with Cloudflare Workers & Deno — 免费

在浏览器中编写并运行真实代码，获得全天候 AI 导师的即时帮助，并在网页或应用中继续学习。

课程: 12
课程: 47

免费开始学习查看完整课程

常见问题解答

「设计 RESTful API」课时是免费的吗？

是的 — 「设计 RESTful API」的完整文本可在网页上免费阅读。要进行交互式练习（内置代码编辑器和全天候 AI 导师）并解锁 Edge Computing with Cloudflare Workers & Deno 课程的其余内容，请升级到 CoddyKit PRO。 Edge Computing with Cloudflare Workers & Deno 课程共包含 3 节课。

「设计 RESTful API」这节课中我会学到什么？

规划并构建适合边缘部署的 RESTful API 端点、方法和数据模型你通过在浏览器中直接运行的动手代码来练习 Edge Computing with Cloudflare Workers & Deno，全天候 AI 导师会在你学习这节课的过程中回答你的问题。

学习 Edge Computing with Cloudflare Workers & Deno 需要有经验吗？

无需任何先前经验。CoddyKit 上的 Edge Computing with Cloudflare Workers & Deno 课程适合初学者到高级学习者，你可以从这里开始或从头开始，按照自己的节奏学习。这是第 1 节课，共 3 节。

「设计 RESTful API」课时需要多长时间？

大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动，所以你能稳步进步，并在网页和应用中从离开的地方继续。

我能在这节 Edge Computing with Cloudflare Workers & Deno 课中编写并运行代码吗？

能。每节 Edge Computing with Cloudflare Workers & Deno 课都包含内置代码编辑器，你可以在浏览器中直接编写并运行真实代码，并获得即时 AI 反馈 — 无需本地设置。

此课程中的所有课时

← 返回 Edge Computing with Cloudflare Workers & Deno