API Reference: [Service / Module]¶
Base URL:
http://localhost:8000(dev) |https://[productie-url](prod)
Authenticatie: [Bearer token / API key / geen]
Content-Type:application/json
Endpoints¶
GET /[pad]¶
Beschrijving: [Wat doet dit endpoint?]
Parameters:
| Parameter | Type | Verplicht | Omschrijving |
|---|---|---|---|
[naam] |
string | ja | [uitleg] |
[naam] |
int | nee | [uitleg], default: [waarde] |
Response 200:
{
"status": "ok",
"data": {}
}
Response 4xx/5xx:
{
"detail": "[foutomschrijving]"
}
POST /[pad]¶
Beschrijving: [Wat doet dit endpoint?]
Request body:
{
"field_1": "string",
"field_2": 0
}
Response 200:
{
"id": "string",
"status": "created"
}
MCP Tools (indien van toepassing)¶
| Tool naam | Beschrijving | Parameters |
|---|---|---|
buurts_[naam] |
[beschrijving] | [param1], [param2] |
Foutcodes¶
| Code | Omschrijving | Actie |
|---|---|---|
| 400 | Ongeldige invoer | Controleer request body |
| 401 | Niet geautoriseerd | Ververs token |
| 404 | Niet gevonden | Controleer ID/pad |
| 500 | Serverfout | Raadpleeg logs |
Voorbeelden¶
import httpx
response = httpx.get("http://localhost:8000/[pad]", params={"key": "value"})
print(response.json())