使用 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。

初始化Ulfius框架

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

#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;
}

上述代码初始化了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"));

 // 将书籍添加到存储的逻辑

 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);

实现其他CRUD操作

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

• 读取（GET）：创建一个GET端点，用于检索图书信息。
• 更新（PUT）：通过PUT端点更新图书的详细信息。
• 删除（DELETE）：通过DELETE端点从存储中移除图书。

每个操作的实现结构与创建功能类似，您可以根据需求定义相应的回调函数。

日志记录功能

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

#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库在C语言中构建一个基本的RESTful API。Ulfius负责处理HTTP请求，而Jansson则用于管理JSON数据。结合C语言的性能优势，您可以高效地开发轻量级的Web API。

需要注意的是，C语言虽然功能强大，但在处理外部输入时需要特别小心，务必验证和净化传入数据，以避免潜在的安全漏洞。

祝您在C语言项目开发中一切顺利！

完整源代码：GitHub链接
完整文档：Ulfius官方文档

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