Skip to content

README.md

Latest commit

 

History

History
56 lines (39 loc) · 3.2 KB

README.md

File metadata and controls

56 lines (39 loc) · 3.2 KB
Raw

Embedded RESTful Services in C and C++

This directory contains the example source code for the tutorial Designing Embedded RESTful Services in C and C++, which shows how to implement a RESTful API using the Barracuda Embedded Web Server library.

This example implements REST routing directly with the BAS/BWS C APIs. It remains the best starting point when a target supports only C or when code and memory overhead must be kept to an absolute minimum. See the Modern C++ REST Service example, which trades some additional requirements and footprint for a much simpler application programming model.

Choosing between the REST examples

Example Use it when Requirements and tradeoffs
C RESTful Service (this example) The target supports only C, or code and memory overhead must be kept to an absolute minimum. Uses the BAS/BWS C APIs directly and does not require the C++ REST library. Route parsing and error handling are implemented explicitly by the application.
Modern C++ REST Service Ease of development, readable route definitions, typed parameters, and reusable REST handling are more important. Requires a modern C++ compiler and the cpp/rest library.

Both examples use the same native BWS server and JSON facilities. The choice depends on the target toolchain, resource budget, and preferred programming model; neither example replaces the other.

🛠️ Building the Project

You can build the project on both Linux and Windows:

  • Linux: Use the provided Makefile
  • Windows: Use the Visual Studio project file RestService.vcxproj
  • To cross-compile for a custom embedded target, refer to the Barracuda porting API documentation and use the appropriate thread and socket abstraction layers.

📂 File Overview

File Path Description
src/RestService.c / RestService.cpp Main RESTful service implementation (C and C++)
src/RestJsonUtils.c Utility functions for JSON parsing/encoding
../HostInit/Main.c Entry point for high-level OS (HLOS) targets
../HostInit/HostInit.c Generic system initialization for HLOS
../../src/BWS.c Barracuda Embedded Web Server core library
../../src/arch/Posix/ThreadLib.c POSIX thread abstraction layer
../../src/arch/NET/generic/SoDisp.c Generic socket dispatcher (TCP layer)

Testing the Service

A Python script is included to test the RESTful API implementation. Before running the script, ensure that the server is listening on port 80 (on Linux run: sudo ./restservice).

To run the test:

python TestApi.py