Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joexbayer/httpcppd
HTTP RESTful API server written in C++ serving static files with routes.
https://github.com/joexbayer/httpcppd
Last synced: 8 days ago
JSON representation
HTTP RESTful API server written in C++ serving static files with routes.
- Host: GitHub
- URL: https://github.com/joexbayer/httpcppd
- Owner: joexbayer
- Created: 2021-07-22T12:41:35.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-08-12T06:32:44.000Z (about 3 years ago)
- Last Synced: 2023-08-09T21:28:45.903Z (about 1 year ago)
- Language: C++
- Homepage:
- Size: 466 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# HTTP C++
### HTTP RESTful API with routes and serving static files.
[WRK](https://github.com/wg/wrk) performance test on xcode - localhost with 20 threads, static file with caching:
```
wrk -t12 -c400 -d30s http://127.0.0.1:8080/
----------------------------------------------
Running 30s test @ http://127.0.0.1:8080/
12 threads and 400 connections
Thread Stats Avg Stdev Max +/- Stdev
Latency 151.58us 38.62us 9.98ms 98.11%
Req/Sec 11.73k 7.19k 56.36k 90.50%
3857851 requests in 30.10s, 761.58MB read
Socket errors: connect 155, read 1471, write 0, timeout 0
Requests/sec: 128165.40
Transfer/sec: 25.30MB
```
(Run on MacBook Pro, 2.3 GHz, 8-core Intel i9, 32gb 2667 DDR4)
[More Benchmarks](Benchmarks.md)
#### How to use:
#### 1.(Optional) Create a config for your http server
You can explicit declare memebers:
```c+
/* Config file for server */
http_config config;
config.port = 8080;
config.thread_pool_size = 99;
config.favicon = "favicon.ico";
config.log_level = VERBOSE;
```
or use the constructor
```c++
http_config config(PORT, THREADS, FAVICON, LOG);
```
#### 2. Create the http server app
Either with or without config:
```c++
/* Create new http server based on config. */
http_server app(config);
or
http_server app();
```
#### 3. Create routes
To create routes you need to define a route, method and function. Best practice is to use a lambda.
(Function needs to take in a request and response pointer.)
```c++
/* GET Route example with static file */
app.route("/", GET, [](request* req, response* res){
res->send("Hello World!");
});
```
To define parameters put a ? after the route and then define parameters between two brackets.
You can access parameters by using the request->params map.
To access headers use the request->headers map.
```c++
/* GET Route example json response and params */
app.route("/json?[age]", GET, [](request* req, response* res){
res->set_contentype("application/json");
/* Use params and return value in json. */
res->send("{name: \""+req->headers["Host"]+"\", age: \"" + req->params["age"] + "\"}");
});
```
Special responses:
```c++
res->send(req->context->send_router_view()); /* Sends a detailed UI for all current routes */
res->set_contentype("application/json"); /* Sents response content type, default is text/html */
res->add_cookie(req->params["username"], req->params["password"]); /* Add a response cookie */
res->send(req->context->stats()); /* Send server stats as JSON */
res->redirect("/"); /* Redirect to given route */
res->send(http_server::static_html("index.html")); /* Sends given HTML file as response */
req->client_ip /* Is a string containing the clients IP used to access the website */
```
Example of ```req->context->stats()```, data collected during runtime.
```javascript
{
"Stats": {
"127.0.0.1": {
"GET / HTTP/1.1": "2",
"GET /favicon.ico HTTP/1.1": "3",
"GET /json?age= HTTP/1.1": "3",
"GET /json?age=21 HTTP/1.1": "1",
"GET /routes HTTP/1.1": "1",
"GET /routes? HTTP/1.1": "2",
"GET /stats? HTTP/1.1": "3",
"POST /example HTTP/1.1": "1",
"Type": "Client"
},
"Authorized requests": "16",
"Responses": "11",
"Status" : "running",
"Using threads" : "2",
"Total threads" : "99"
}
}
```
#### 4. Add an authentication token (OPTIONAL) and run the server
```c++
/* Adding cookie token authentication. */
app.authentication("secret-token");
/* Start server */
app.run()
```