File: README.md

package info (click to toggle)
ulfius 2.7.15-2.2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 3,856 kB
  • sloc: ansic: 23,025; makefile: 708; sh: 140
file content (37 lines) | stat: -rw-r--r-- 1,749 bytes parent folder | download | duplicates (2)
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
# sheep_example

Run a simple file webserver and a small REST API that listen on port 7437, and implement a file upload service.

## Compile and run

```bash
$ make test
```

## Usage:

### Sheep counter

Open in your browser the url [http://localhost:7437/static/index.html](http://localhost:7437/static/index.html), it's a jquery application that will count and display sheeps to help you fall asleep. There click on the buttons available to call the underline API.

The API endpoints are the following:

- `POST http://localhost:7437/sheep`: Initialise the counter with the specified `nbsheep` value provided in the json body (default 0) and return the new `nbsheep` value in the response as a json. The JSON body must be a single numeric value.
- `PUT http://localhost:7437/sheep`: Add a sheep to the current counter and return the new `nbsheep` value in the response as a json
- `DELETE http://localhost:7437/sheep`: Reset the sheep counter to 0 and return the new `nbsheep` value in the response as a json

### File upload

Open in your browser the url [http://localhost:7437/static/upload.html](http://localhost:7437/static/upload.html), there upload a file, preferably not a big one, then click on the `Upload File` button.

The API endpoint is the following:

- `http://localhost:7437/upload`: upload a file and show informations about it in the response.

### Form POST

Open in your browser the url [http://localhost:7437/static/form.html](http://localhost:7437/static/form.html), there enter values in the input, then click on the `send form` button. The console will display the form parameters.

The API endpoint is the following:

- `http://localhost:7437/static/submit`: submit a form and show informations about it in the response.