Probeer en test de API lokaal

Voor de BRP API Personen is een mock beschikbaar als een containerized applicatie. Deze kun je gemakkelijk hosten op een lokale machine of in de testomgeving van jouw organisatie. Het voordeel van deze oplossing is dat je je eigen testgevallen kunt toevoegen aan het JSON bestand. Standaard maakt de BRP API Personen mock gebruik van de testdataset persoonslijsten proefomgevingen GBA-V om de productie situatie zo goed mogelijk te simuleren.

Je kunt het docker compose bestand gebruiken om de BRP API Personen mock met behulp van Docker Desktop te draaien op een lokale machine.

Je kunt er ook voor kiezen om de Kubernetes configuratie bestanden gebruiken om de BRP API Personen mock te draaien op een lokale machine.

De volgende paragrafen beschrijven wat je moet doen om de BRP API Personen mock op een lokale machine te installeren en aan te roepen.

Prerequisites

Docker Desktop voor het hosten van containers
Zet Kubernetes ondersteuning aan in Docker Desktop in het Settings/Kubernetes configuratie scherm om Docker Desktop te gebruiken om de containers te hosten met behulp van de Kubernetes engine.

Enable Kubernetes

Optioneel kun je de volgende tools ook op de lokale machine installeren:

git voor het clonen van git repositories
Postman voor het aanroepen van BRP API

Gebruik Docker als container engine

Download het Personen docker compose bestand
Start een command prompt window voor de map met het docker-compose.yaml bestand
Start de BRP API Personen mock met behulp van het volgende statement:
```
docker-compose -f docker-compose-mock.yml up -d
```
De BRP API Personen mock is nu te benaderen via de url: http://localhost:5001/haalcentraal/api/brp/personen

Valideer dat de BRP API mock draait met behulp van het volgende curl statement:


curl --location --request POST 'http://localhost:5001/haalcentraal/api/brp/personen' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "RaadpleegMetBurgerservicenummer",
    "burgerservicenummer": ["999993653"],
    "fields": ["burgerservicenummer"]
}'

Om de BRP API Personen mock container te stoppen voer je het volgende statement uit:
```
docker-compose -f docker-compose-mock.yml down
```

Gebruik Kubernetes als container engine

Download de Personen kubernetes configuratie bestanden
Start een command prompt window voor de map met de kubernetes manifest bestanden
Start de BRP API en de mock met behulp van het volgende statement:
```
kubectl apply -f .k8s/brppersonenmock-deployment.yaml \
              -f .k8s/brppersonenmock-service.yaml 
```
De BRP API Personen mock is nu te benaderen via de url: http://localhost:5001/haalcentraal/api/brp/personen

Valideer dat de BRP API Personen mock draait met behulp van het volgende curl statement:


curl --location --request POST 'http://localhost:5001/haalcentraal/api/brp/personen' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "RaadpleegMetBurgerservicenummer",
    "burgerservicenummer": ["999993653"],
    "fields": ["burgerservicenummer"]
}'

Om de BRP API Personen mock container te stoppen voer je het volgende statement uit:



kubectl delete -f .k8s/brppersonenmock-deployment.yaml \
               -f .k8s/brppersonenmock-service.yaml