aboutsummaryrefslogblamecommitdiffhomepage
path: root/dummy-data/README.md
blob: 6a54be373a4a5483d17570cc917822164137f8f5 (plain) (tree)
1
2
3
4
5
6
7
8
9
10
11

            
                                                                                                                          

                                                                                                                                                                                          





                                             
                                   
 
                                                                                           


                                                                 

     
            
                                                                                                                                                                                  
   
# Dummy data

This directory content makes possible to test custom services cards or create a demo without actually running the service.
The principle is simple: save a sample output of the API used in the service in a static file in this directory. The path must be identical as the service endpoint to be used seamlessly.

## Start the mock server to expose dummy data

```sh
yarn mock
```

## How to add a new services sample

- create a directory for your service, and any sub-folder existing in the service api path.
- save the api output in a file named after the service endpoint.

Example:

```sh
mkdir pihole
curl http://my-pihole.me/admin/api.php -o pihole/api.php # /admin is omitted because for PiHole, the implementation expect it to be in the base url (`url` or `endpoint` property)
```