aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: d15849aa7c49b09a81194258a13c91e68e9ad7e5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
# UMoSApi

This is a second implementation in C++ of the [Python](https://git.neodarz.net/pro/umosapi.git/about/)
version of Unity Mongo Save Api. This is a simple API for save Unity object in
Mongo database.

# Install

## Dependency

Install:

- Pistache
- json-c
- nlohmann/json
- mongocxx

### Why two json lib ?

Because json-c is more fast than nlohmann/json when I do the test, json-c lib
is only used for convert bson to json and vice versa. The nlohmann/json is
only used for simplicty when loading config file.

# Build

```
mkdir build
cd build
cmake ..
make
```

move `umosapi` binary where you want.

move `swagger-ui` folder where you want.

# Configuration

You can move the [example file](https://git.neodarz.net/pro/umosapicpp.git/tree/config.txt)
in `~/.config/umosapi/config.txt`.

The key `swaggerui` is the path of the `swagger-ui` folder. The other keys
speak by themself.

# Documentation

Juste launch `umosapi` and go here: [http://127.0.0.1:9080/doc](http://127.0.0.1:9080/doc)