使用 Ulfius 在 C 语言中构建 RESTful API

使用C语言创建RESTful API不仅能够加深您对Web技术和C语言能力的理解，更是一次极具价值的实践体验。本教程将指导您使用Ulfius框架处理HTTP请求，并结合Jansson库进行JSON操作，开发一个简单的图书CRUD API。

C语言以高效和可控著称，虽然它并不是Web服务器开发的主流选择，但借助合适的库，C语言完全可以构建轻量级且高性能的Web API。Ulfius框架与Jansson库的结合，为C程序员提供了开发快速灵活的RESTful API的可能性。

开发环境准备

在开始编码之前，请确保您的系统已安装以下必要组件：

• GCC编译器：用于编译C语言代码。
• Ulfius框架：处理HTTP请求的核心框架。
• Jansson库：用于操作JSON数据的库。

您可以通过官方渠道或系统的包管理器安装Ulfius和Jansson。

项目概述

我们的API将管理一个包含ID和名称的简易图书模型。以下是使用C语言定义的基本结构，并展示了如何初始化Ulfius框架实例及配置端点URL。

#include 
#define PORT 8080

int main(void) {
    struct _u_instance instance;

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

    // 在此处声明端点

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

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

创建图书功能

我们首先定义一个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"));

    // 在此处添加逻辑将图书存储到数据库或内存中

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

在启动框架之前，需要将该端点添加到实例中：

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

查询、更新与删除功能

按照与创建图书类似的模式，可以实现以下功能：

• 查询图书：通过GET端点获取图书信息。
• 更新图书：通过PUT端点修改图书信息。
• 删除图书：通过DELETE端点移除图书。

以下是一个简单的请求日志函数，用于记录每次请求的详细信息：

#include 
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 %sn", formatted_time, request->http_verb, request->http_url);
}

注意事项

本教程展示了如何利用Ulfius框架和Jansson库构建一个基础的RESTful API。Ulfius负责处理HTTP请求，而Jansson则用于操作JSON数据，这两者的结合充分发挥了C语言的性能优势。

然而，C语言虽然强大高效，但在开发Web应用时需要特别注意以下几点：

1. 内存管理：确保分配的内存能够正确释放，避免内存泄漏。
2. 输入验证：对外部输入进行严格验证和净化，以防止潜在的安全漏洞。

总结

通过本教程，您已经了解了如何使用C语言结合Ulfius框架和Jansson库构建一个简单的RESTful API。尽管C语言并非Web开发的主流选择，但它在性能和灵活性方面的优势使其成为某些场景下的理想工具。

祝您编程愉快，愿您的C项目顺利无Bug！

相关资源

• 完整源代码：GitHub仓库
• Ulfius框架文档：官方文档

原文链接: https://leo88.medium.com/building-a-restful-api-with-ulfius-in-c-d1ce6b979508