Maak een OpenAPI-specificatie die geavanceerde health check-mechanismen integreert voor mijn API
description
Door het implementeren van health check-mechanismen kan ik ervoor zorgen dat mijn API beschikbaar en responsief blijft, wat uiteindelijk de gebruikerservaring en systeem betrouwbaarheid verbetert.
prompt
try_prompt
Help me een OpenAPI-specificatie maken die uitgebreide health check-mechanismen bevat om de status en beschikbaarheid van mijn API te monitoren. Geef alsjeblieft de volgende details: API Naam: {{api_n ... more
generate_helper
...
ai_answers
provider: openai
model: gpt-4.1-nano
{
"openapi": "3.0.0",
"info": {
"title": "Voorbeeld API",
"version": "1.0.0",
"description": "OpenAPI-specificatie met uitgebreide health check-mechanismen voor monitoring."
},
"paths": {
"/health": {
"get": {
"summary": "Health check endpoint",
"description": "Geeft de status en beschikbaarheid van de API terug.",
"responses": {
"200": {
"description": "API is gezond",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"type": "string",
"example": "healthy"
}
},
"required": ["status"]
}
}
}
},
"503": {
"description": "API niet beschikbaar of niet gezond",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"type": "string",
"example": "unhealthy"
}
},
"required": ["status"]
}
}
}
}
},
"security": [
{
"apiAuth": []
}
]
}
}
},
"components": {
"securitySchemes": {
"apiAuth": {
"type": "apiKey",
"name": "X-API-KEY",
"in": "header",
"description": "Authenticatie met Voorbeeld API-sleutel"
}
}
}
}
provider: deepseek
model: deepseek-chat
{
"openapi": "3.0.0",
"info": {
"title": "Voorbeeld API",
"version": "1.0.0",
"description": "Een API met uitgebreide health check-mechanismen voor het monitoren van de status en beschikbaarheid."
},
"servers": [
{
"url": "https://api.voorbeeld.com/v1"
}
],
"paths": {
"/health": {
"get": {
"summary": "Health Check",
"description": "Endpoint om de status en beschikbaarheid van de API te controleren. Aanbevolen wordt om dit elke 5 minuten te monitoren.",
"tags": [
"Monitoring"
],
"security": [
{
"apiKey": []
}
],
"responses": {
"200": {
"description": "De API is gezond en beschikbaar.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"type": "string",
"example": "healthy"
}
},
"required": [
"status"
]
}
}
}
},
"503": {
"description": "De API is niet beschikbaar of heeft problemen.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"type": "string",
"example": "unhealthy"
},
"details": {
"type": "string",
"example": "Database connection failed"
}
}
}
}
}
}
}
}
}
},
"components": {
"securitySchemes": {
"apiKey": {
"type": "apiKey",
"name": "X-API-Key",
"in": "header",
"description": "Authenticatiemethode voor Voorbeeld API"
}
}
}
}