使用C语言创建REST API的完整指南

REST API 是现代应用程序开发中不可或缺的一部分，但您是否想过如何使用 C 语言实现它？由于 C 语言缺乏对字符串等基本资源的直接支持，以及对 JSON 格式的原生支持不足，用 C 实现 REST API 可能会显得尤为复杂。然而，通过本文，您将了解如何使用 C 语言构建一个简单的 REST API，并直接与数据库交互。

使用 libpq 库连接数据库

在这个项目中，我们使用了 libpq，这是 PostgreSQL 官方提供的 C 库。它允许开发者直接连接到数据库，执行查询，并高效地操作结果。虽然 C 语言需要开发者更加关注内存管理和数据结构，但 libpq 提供了对数据库通信的完全控制，避免了高级语言中常见的抽象层。这使得它非常适合需要高性能和细粒度数据库控制的应用程序。

项目初始化：创建一个简单的 HTTP 服务器

在项目中，我们使用了 libmicrohttpd 库来设置一个简单的 HTTP 服务器。以下是初始化服务器的代码示例：

#include 
#include 
#include 
#include "headers/handler.h"

#define PORT 8080

int main() {
 printf("Starting server on port %dn", PORT);

 struct MHD_Daemon *daemon;

 daemon = MHD_start_daemon(MHD_USE_THREAD_PER_CONNECTION, PORT, NULL, NULL,
 &default_handler, NULL, MHD_OPTION_END);
 if (!daemon)
 return 1;

 while (1)
 sleep(1);

 MHD_stop_daemon(daemon);

 return 0;
}

在这段代码中，我们通过 libmicrohttpd 库启动了一个监听 8080 端口的 HTTP 服务器。MHD_USE_THREAD_PER_CONNECTION 标志确保每个连接都在单独的线程中处理。default_handler 函数用于处理所有传入的请求，而 while 循环则保持服务器运行，直到被手动中断。

处理 HTTP 请求的核心逻辑

以下是 default_handler 函数的实现，它负责处理 HTTP 服务器的传入请求：

enum MHD_Result default_handler(
 void *cls, struct MHD_Connection *connection, 
 const char *url, const char *method, const char *version,
 const char *upload_data, size_t *upload_data_size, void **con_cls) {

 char *url_str = (char *)url;
 char *method_str = (char *)method;
 int ret;

 struct MHD_Response *response;
 HTTP_response response_api;

 log_api(url_str, method_str); // 记录请求的 URL 和方法

 TRY {
 if (strcmp(url_str, "/") == 0) {
 response_api = (HTTP_response){
 .body = simple_message("Hello world!"),
 .status = OK
 };
 } else if (validate_route(url_str, "/users")) {
 response_api = user_router(url_str, method_str, upload_data);
 } else {
 response_api = (HTTP_response){
 .body = simple_message("Not found"),
 .status = NOT_FOUND
 };
 }
 } CATCH {
 response_api = (HTTP_response){
 .body = simple_message("Internal server error"),
 .status = INTERNAL_SERVER_ERROR
 };

 printf("Internal server error");
 }

 response = HTTP_build_response_JSON(response_api.body); // 构建 JSON 格式的 HTTP 响应

 if (!response)
 return MHD_NO;

 ret = MHD_queue_response(connection, response_api.status, response); // 将响应加入队列
 MHD_destroy_response(response); // 释放响应内存

 return ret; // 返回结果
}

函数解析：

1. 记录请求信息：函数首先通过 log_api 记录请求的 URL 和方法。
2. 路由处理：
   • 如果 URL 是根路径（/），返回一条简单的 "Hello world!" 消息和状态码 200 OK。
   • 如果 URL 是 /users，调用 user_router 函数处理该请求。
   • 如果 URL 无法识别，返回状态码 404 Not Found。
3. 错误处理：如果在处理过程中发生错误，返回状态码 500 Internal Server Error，并在控制台打印错误日志。
4. 构建响应：使用 HTTP_build_response_JSON 函数将响应数据格式化为 JSON，并将其发送到客户端。

项目扩展建议

通过上述代码，您已经了解了如何使用 C 语言创建一个简单的 REST API。接下来，您可以基于此进一步扩展功能，例如：

• 构建更复杂的 JSON 响应：探索如何动态生成和处理 JSON 数据。
• 路由管理：设计更灵活的路由系统，以支持更多的 API 端点。
• 数据库交互：使用 libpq 执行复杂的数据库操作，例如用户验证或数据分析。

总结

本文展示了如何使用 C 语言创建一个简单的 REST API，包括如何设置 HTTP 服务器、处理请求以及构建 JSON 响应等内容。虽然 C 语言在开发 REST API 时需要更多的底层操作，但它提供了极高的性能和灵活性，非常适合需要精细控制的场景。

如果您对本文内容感兴趣，建议访问 rest-api-c 存储库，进一步了解其实现细节，并尝试构建自己的 REST API！

原文链接: https://pedrofnseca.medium.com/how-to-create-an-rest-api-using-c-9150882320d4