Ontwerp een OpenAPI Specificatie voor API Feedback en Gebruikservaring
description
Met deze prompt kan de gebruiker een OpenAPI specificatie ontwerpen die het verzamelen van waardevolle feedback en het meten van gebruikservaring ondersteunt. Dit helpt bij het verbeteren van API kwaliteit en gebruikersgerichtheid, wat ontbreekt in bestaande prompts die zich meer richten op technische aspecten zoals beveiliging of documentatie.
prompt
Help mij een OpenAPI specificatie te maken die expliciet gericht is op het verzamelen van feedback van API-gebruikers en het meten van gebruikservaring. API Naam: <voer de naam van mijn API in> Feedback Mechanismen (bijv. foutmeldingen, gebruikerscommentaar): <beschrijf de manieren waarop feedback wordt verzam ...
try_prompt
generate_helper
disclaimerOnPageApi
tags
ai_answers
provider: openai
model: gpt-4.1-nano
openapi: 3.0.3
info:
title: Feedback API
versie: 1.0.0
beschrijving: >
Een API voor het verzamelen van gebruikersfeedback en het meten van gebruikservaring, inclusief mechanismen voor gebruikerscommentaar en foutmeldingen, en indicatoren zoals responstijd en foutpercentages.
servers:
- url: https://api.example.com
beschrijving: Productie server
security:
- apiKeyAuth: []
components:
securitySchemes:
apiKeyAuth:
type: apiKey
in: header
name: X-API-Key
schemas:
Feedback:
type: object
eigenschappen:
gebruikerId:
type: string
beschrijving: Unieke identificatie van de gebruiker
feedbackType:
type: string
enum: [gebruikerscommentaar, foutmelding]
beschrijving: Type feedback
bericht:
type: string
beschrijving: Het feedbackbericht of foutmelding
timestamp:
type: string
format: date-time
beschrijving: Tijdstip van indiening
Gebruikservaringsgegevens:
type: object
eigenschappen:
responstijd:
type: number
beschrijving: Gemiddelde responstijd in milliseconden
foutpercentage:
type: number
format: float
beschrijving: Percentage foutmeldingen gerelateerd aan totaal verzoeksverkeer
parameters:
GebruikerIdParam:
naam: gebruikerId
in: path
required: true
schema:
type: string
beschrijving: ID van de gebruiker
paths:
/feedback:
post:
summary: Plaats gebruikersfeedback of foutmeldingen
beveiliging:
- apiKeyAuth: []
requestBody:
required: ja
content:
application/json:
schema:
$ref: '#/components/schemas/Feedback'
responses:
'201':
description: Feedback succesvol ontvangen
'400':
description: Ongeldige aanvraag
/gebruikservaring:
get:
summary: Haal gebruikservaringsgegevens op
beveiliging:
- apiKeyAuth: []
parameters:
- $ref: '#/components/parameters/GebruikerIdParam'
responses:
'200':
description: Gebruikservaringsgegevens
content:
application/json:
schema:
$ref: '#/components/schemas/Gebruikservaringsgegevens'
'404':
description: Gegevens niet gevonden
/feedback/{gebruikerId}:
get:
summary: Haal feedback van een specifieke gebruiker op
beveiliging:
- apiKeyAuth: []
parameters:
- $ref: '#/components/parameters/GebruikerIdParam'
responses:
'200':
description: List van feedbackberichten
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Feedback'
'404':
description: Geen feedback gevonden voor deze gebruiker
security:
- apiKeyAuth: []
provider: deepseek
model: deepseek-chat
```yaml
openapi: 3.0.3
info:
title: Feedback API
description: API voor het verzamelen van gebruikersfeedback en meten van gebruikservaring
version: 1.0.0
contact:
name: API Support
email: support@voorbeeld.com
servers:
- url: https://api.voorbeeld.com/v1
description: Productieserver
paths:
/feedback:
post:
summary: Verzend gebruikersfeedback
description: Endpoint voor het verzamelen van gebruikerscommentaar en feedback
tags:
- Feedback
security:
- apiKey: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- type
- message
properties:
type:
type: string
description: Type feedback
enum:
- gebruikerscommentaar
- foutmelding
- suggestie
- vraag
message:
type: string
description: De feedback boodschap
maxLength: 1000
severity:
type: string
description: Ernst van de feedback (alleen voor foutmeldingen)
enum:
- laag
- gemiddeld
- hoog
- kritiek
context:
type: object
description: Additionele context informatie
properties:
endpoint:
type: string
user_agent:
type: string
timestamp:
type: string
format: date-time
responses:
'201':
description: Feedback succesvol ontvangen
content:
application/json:
schema:
type: object
properties:
feedback_id:
type: string
description: Unieke identifier voor de feedback
received_at:
type: string
format: date-time
'400':
description: Ongeldige feedback data
'401':
description: Niet geautoriseerd - API sleutel ontbreekt of is ongeldig
/metrics/performance:
get:
summary: Haal prestatiemetrics op
description: Endpoint voor het ophalen van gebruikservaringsindicatoren
tags:
- Metrics
security:
- apiKey: []
parameters:
- name: timeframe
in: query
description: Tijdsperiode voor metrics
schema:
type: string
enum:
- laatste_uur
- laatste_24_uur
- laatste_week
- laatste_maand
required: true
- name: endpoint
in: query
description: Specifiek endpoint filter (optioneel)
schema:
type: string
responses:
'200':
description: Prestatiemetrics succesvol opgehaald
content:
application/json:
schema:
type: object
properties:
responstijd:
type: object
properties:
gemiddeld:
type: number
format: float
description: Gemiddelde responstijd in milliseconden
p95:
type: number
format: float
description: 95e percentiel responstijd in milliseconden
p99:
type: number
format: float
description: 99e percentiel responstijd in milliseconden
foutpercentages:
type: object
properties:
totaal:
type: number
format: float
description: Totaal foutpercentage
per_endpoint:
type: object
additionalProperties:
type: number
format: float
beschikbaarheid:
type: number
format: float
description: Beschikbaarheidspercentage
'401':
description: Niet geautoriseerd - API sleutel ontbreekt of is ongeldig
/metrics/feedback/summary:
get:
summary: Haal feedback samenvatting op
description: Endpoint voor het ophalen van samenvatting van ontvangen feedback
tags:
- Metrics
security:
- apiKey: []
parameters:
- name: timeframe
in: query
description: Tijdsperiode voor feedback samenvatting
schema:
type: string
enum:
- laatste_24_uur
- laatste_week
- laatste_maand
required: true
responses:
'200':
description: Feedback samenvatting succesvol opgehaald
content:
application/json:
schema:
type: object
properties:
totaal_feedback:
type: integer
per_type:
type: object
properties:
gebruikerscommentaar:
type: integer
foutmelding:
type: integer
suggestie:
type: integer
vraag:
type: integer
gemiddelde_ernst:
type: number
format: float
'401':
description: Niet geautoriseerd - API sleutel ontbreekt of is ongeldig
components:
securitySchemes:
apiKey:
type: apiKey
name: X-API-Key
in: header
description: API sleutel voor authenticatie
schemas:
Error:
type: object
properties:
error:
type: string
message:
type: string
code:
type: integer
tags:
- name: Feedback
description: Endpoints voor het verzamelen van gebruikersfeedback
- name: Metrics
description: Endpoints voor het meten van gebruikservaring en prestaties
```