c-api-server

This repository contains a library that allows the user to setup a server using C. The user will be able to create an JSON REST API server by registering paths and associating them with callbacks to handle incoming requests. As this is a hobby project, it is not meant for production use. The focus at the end will be on performance, developing different approaches to get the most performance. This will be benchmarked and documented.

This project expands upon the c server that I built for my tiny-django project. It also uses my own c implementation of a thread pool.

Compilation

To compile an example server implementation, first compile the example server:

make implementation

Then create the docker image by running the following command:

docker build -t json-server .

Run

To run the server, start the docker container using docker-compose:

docker compose up

Add the -d flag to detach immediately to run the container in the background. To stop the container, run:

docker compose down

Benchmarking

Benchmarking is done using Apache Benchmark to measure if performance improvements actually improve performance. All tests are done using the scripts in the benchmark-scripts repository.

Functionality

The envisioned functionality will be:

• Associating paths with callbacks.
• Supports json responses.
• Optimization for latency and load handling, with benchmarking scripts to test improvements.
• A user-friendly API.