C语言快速上手RESTful API开发指南｜Ulfius + Jansson实战教程

一. 环境准备

在开始构建 RESTful API 之前，请确保您的系统已安装以下组件：

1. GCC编译器

用于编译 C 语言代码，保证程序能够在本地顺利运行。

2. Ulfius框架

处理 HTTP 请求，支持快速创建 RESTful API 端点。

3. Jansson库

用于管理 JSON 数据，便于序列化和解析 API 请求与响应。

建议通过操作系统的软件包管理器安装 Ulfius 和 Jansson，或从官方来源下载最新版本。

二. 初始化 Ulfius 框架

我们的 API 将管理一个简单的图书模型，每本书包含 ID 和名称。以下是基本代码示例：

#include <ulfius.h>
#include <stdio.h>

#define PORT 8080

int main(void) {
    struct _u_instance instance;

    if (ulfius_init_instance(&instance, PORT, NULL, NULL) != U_OK) {
        fprintf(stderr, "Error initializing instance\n");
        return 1;
    }

    // 在此处添加端点

    if (ulfius_start_framework(&instance) == U_OK) {
        printf("Server started on port %d\n", instance.port);
        getchar(); // 等待用户输入停止服务器
    } else {
        fprintf(stderr, "Error starting framework\n");
    }

    ulfius_stop_framework(&instance);
    ulfius_clean_instance(&instance);
    return 0;
}

a. 说明

该代码初始化了 Ulfius 实例并指定端口号。通过 ulfius_start_framework 启动服务器后，您可以通过指定端口访问 API。

三. 创建图书的 POST 端点

为了实现图书的创建功能，我们需要定义一个 POST 端点：

int callback_create_book(const struct _u_request *request, struct _u_response *response, void *user_data) {
    json_t *json_body = ulfius_get_json_body_request(request, NULL);
    const char *name = json_string_value(json_object_get(json_body, "name"));

    // TODO: 将书籍添加到存储逻辑中

    json_decref(json_body);
    ulfius_set_string_body_response(response, 200, "Book created");
    return U_CALLBACK_CONTINUE;
}

a. 添加端点到实例

ulfius_add_endpoint_by_val(&instance, "POST", "/book", NULL, 0, &callback_create_book, NULL);

四. 实现其他 CRUD 操作

除了创建功能，您还可以实现以下操作：

1. 读取（GET）

创建一个 GET 端点，用于检索图书信息。

2. 更新（PUT）

通过 PUT 端点更新图书详细信息。

3. 删除（DELETE）

通过 DELETE 端点从存储中移除图书。

每个操作的实现结构与创建功能类似，只需定义对应回调函数即可。

五. 日志记录功能

为了便于调试和监控，可以实现一个简单日志记录功能，用于记录每个 HTTP 请求的信息：

#include <time.h>
#include <stdio.h>

void log_request(const struct _u_request *request) {
    time_t now = time(NULL);
    char formatted_time[20];
    strftime(formatted_time, 20, "%Y-%m-%d %H:%M:%S", localtime(&now));
    printf("[%s] Received %s request for %s\n", formatted_time, request->http_verb, request->http_url);
}

六. 安全与最佳实践

数据验证：C 语言处理外部输入时需要格外小心，务必验证和净化数据。
内存管理：确保正确释放 JSON 对象和动态分配内存，避免内存泄漏。
结构化日志：便于调试和性能分析。

七. 总结

通过本教程，您学习了如何使用 Ulfius 和 Jansson 在 C 语言中构建 RESTful API：

Ulfius：负责处理 HTTP 请求
Jansson：管理 JSON 数据
C 语言优势：高效、可控，适合开发轻量级 Web API

完整源代码：GitHub链接
原文链接: https://gotz.medium.com/building-a-restful-api-with-ulfius-in-c-d1ce6b979508