DictatorDatabase Gebruikershandleiding

Inhoudsopgave

• Aan de slag
• Configuratie
• API Endpoints
  • GET /data
  • GET /history
  • GET /search/<search_terms>
  • POST /data
  • POST /data/rollback
  • PUT /data/<index>
  • DELETE /data/<index>
• Foutafhandeling
• Logging
• Integratiehandleiding
  • HTTP Communicatie
  • Voorbeeldtoepassingen

Aan de slag

1. Installeer Afhankelijkheden: Zorg ervoor dat je Python 3.12 of later hebt en installeer de benodigde Python-pakketten:

   pip install pyyaml

2. Configureer de Server: Maak een config.yml bestand in dezelfde directory als het server script met de volgende inhoud:

   server:
     port: 8000
   
   database:
     file_path: database.ddb
   
   logging:
     log_file: server.log
   

3. Start de Server:

   python databaseserver.py

   De server start en luistert op de poort die is opgegeven in config.yml (standaard: 8000).

Configuratie

Het gedrag van de server wordt gecontroleerd via het config.yml bestand. Hier is wat elke sectie betekent:

• server: Bevat server-specifieke instellingen.
  • port: De poort waarop de server luistert naar binnenkomende verzoeken.
• database: Definieert het database bestandspad.
  • file_path: Het bestand waarin de database is opgeslagen. Het bestand moet toegankelijk en beschrijfbaar zijn.
• logging: Configureert logging.
  • log_file: Het bestand waarin logs worden geschreven. Zorg ervoor dat dit bestand beschrijfbaar is.

API Endpoints

GET /data

Omschrijving: Haalt de volledige dataset op, exclusief de geschiedenis.

Reactie:
Status Code: 200 OK
Content-Type: application/json
Body:

{
  "data": [...]
}

GET /history

Omschrijving: Haalt de geschiedenis van wijzigingen aan de database op.

Reactie:
Status Code: 200 OK
Content-Type: application/json
Body:

[
  {
    "action": "add",
    "data": {...},
    "timestamp": "ISO8601_TIMESTAMP",
    "old_data": null
  },
  ...
]

GET /search/<search_terms>

Omschrijving: Doorzoekt de database naar gegevens die overeenkomen met de opgegeven zoektermen.

Reactie:
Status Code: 200 OK
Content-Type: application/json
Body:

[
  {
    "matching_key": "matching_value",
    ...
  }
]

POST /data

Omschrijving: Voegt een nieuwe invoer toe aan de database.

Request Body:
Content-Type: application/json
Body:

{
  "key": "value",
  ...
}

Reactie:
Status Code: 200 OK
Content-Type: application/json
Body:

{
  "message": "Data toegevoegd met succes"
}

POST /data/rollback

Omschrijving: Rol de laatste wijziging aan de database terug.

Reactie:
Status Code: 200 OK
Content-Type: application/json
Body:

{
  "message": "Rollback succesvol"
}

PUT /data/<index>

Omschrijving: Werk een bestaande invoer in de database bij.

Request Body:
Content-Type: application/json
Body:

{
  "key": "new_value",
  ...
}

Reactie:
Status Code: 200 OK
Content-Type: application/json
Body:

{
  "message": "Data succesvol bijgewerkt"
}

DELETE /data/<index>

Omschrijving: Verwijdert een invoer uit de database.

Reactie:
Status Code: 200 OK
Content-Type: application/json
Body:

{
  "message": "Data succesvol verwijderd"
}

Foutafhandeling

• 400 Bad Request: Geeft een verkeerd verzoek of ongeldige gegevens aan.
• 404 Not Found: De opgevraagde bron kon niet worden gevonden.
• 500 Internal Server Error: Er is een onverwachte serverfout opgetreden.

Logging

De server logt zijn activiteiten naar het bestand dat is opgegeven in config.yml onder logging.log_file. Dit omvat:

• Verzoeken en antwoorden
• Fouten en waarschuwingen
• Statusupdates

Integratiehandleiding

HTTP Communicatie

Om met de DictatorDatabase server te communiceren, gebruik je HTTP-methoden om met de volgende eindpunten te communiceren:

• GET: Haal gegevens of geschiedenis op, voer zoekopdrachten uit.
• POST: Voeg nieuwe gegevens toe, voer rollbacks uit.
• PUT: Werk bestaande gegevens bij.
• DELETE: Verwijder gegevens.

Voorbeeld met curl:

• GET /data:
  

  curl -X GET http://localhost:8000/data

• POST /data:
  

  curl -X POST http://localhost:8000/data -H "Content-Type: application/json" -d '{"key": "value"}'

• GET /search/example:
  

  curl -X GET http://localhost:8000/search/example

• PUT /data/0:
  

  curl -X PUT http://localhost:8000/data/0 -H "Content-Type: application/json" -d '{"key": "new_value"}'

• DELETE /data/0:
  

  curl -X DELETE http://localhost:8000/data/0

Voorbeeldtoepassingen

• Gegevens Toevoegen: Integreer met een webapplicatie om gebruikers in staat te stellen gegevensinvoer via formulieren in te dienen.
• Gegevens Ophalen: Gebruik de /data eindpunt om gebruikersinterfaces te vullen of rapporten te genereren.
• Gegevens Doorzoeken: Implementeer zoekfunctionaliteit in toepassingen om relevante gegevens uit de database te filteren en weer te geven.
• Rollback Functionaliteit: Bied gebruikers de mogelijkheid om wijzigingen terug te draaien, nuttig voor ongedaan maken functies in toepassingen.

Deze handleiding zou je moeten helpen DictatorDatabase effectief te begrijpen en te gebruiken. Voor eventuele problemen of verdere assistentie, raadpleeg de serverlogs of neem contact op met het ondersteuningsteam.