项目简介
本项目是一个基于C语言和ulfius框架的嵌入式系统Web服务应用。鉴于嵌入式系统常需远程访问,RESTful API是常用的远程通信和操作方式,本项目实现了基本的RESTful API,涵盖用户管理和计数器管理两个服务,为用户提供简单的Web服务接口来管理用户和计数器信息。
项目的主要特性和功能
- 用户服务
- 创建用户:通过
POST /api/users
接口,能在操作系统中创建用户,创建成功后用户可通过SSH登录,同时会在用户计数器服务中增加计数器值,若计数器服务不可用或失败会记录错误。 - 获取用户列表:使用
GET /api/users
接口,可获取操作系统中所有用户及其标识符信息。
- 创建用户:通过
- 计数器服务
- 增加计数器值:利用
POST /counter/increment
接口,可增加计数器的值。 - 获取计数器当前值:通过
GET /counter/value
接口,能获取计数器的当前值。
- 增加计数器值:利用
- 其他特性:具备Nginx反向代理服务,可使用logrotate服务记录所有活动,还提供
crear_usuario.sh
脚本,能通过简单用户界面创建用户。
安装使用步骤
安装步骤
假设用户已下载本项目的源码文件,安装步骤如下:
1. 复制仓库
sh
2. 编译项目
sh
make install
使用步骤
安装成功后,可通过指向API的POST端点来使用服务。具体接口使用示例如下:
用户服务
- 创建用户
C POST http://{{server}}/api/users
请求示例:C curl --request POST \ --url http://{{server}}/api/users \ -u USER:SECRET \ --header 'accept: application/json' \ --header 'content-type: application/json' \ --data '{"username": "myuser", "password": "mypassword"}'
- 获取用户列表
C GET http://{{server}}/api/users
请求示例:C curl --request GET \ --url http://{{server}}/api/users \ -u USER:SECRET \ --header 'accept: application/json' \ --header 'content-type: application/json'
计数器服务
- 增加计数器值
C POST http://{{server}}/counter/increment
请求示例:C curl --request POST \ --url http://{{server}}/counter/increment \ -u USER:SECRET \ --header 'accept: application/json' \ --header 'content-type: application/json'
- 获取计数器当前值
C GET http://{{server}}/counter/value
请求示例:C curl --request GET \ --url http://{{server}}/counter/value \ -u USER:SECRET \ --header 'accept: application/json' \ --header 'content-type: application/json'
卸载步骤
若需卸载项目,可使用以下命令:
sh
make remove
下载地址
点击下载 【提取码: 4003】【解压密码: www.makuang.net】