Maak een OpenAPI Specificatie voor API Verouderingsbeheer
description
Maakt duidelijke communicatie mogelijk over verouderde API endpoints en hun vervangingen, vermindert integratiefouten en verbetert de ontwikkelaarservaring door gestructureerd verouderingsbeheer in de OpenAPI specificatie op te nemen. Deze prompt helpt om de API levenscyclus transparant te houden en faciliteert soepelere overgangen dan ongedocumenteerde verouderingen.
prompt
Help me een OpenAPI specificatie te maken die duidelijk het verouderingsbeleid en beheer voor mijn API documenteert.
API Naam: <voer de naam van mijn API in>
Verouderde Endpoints: <lijst endpoints die verouderd zijn>
Verouderingsdata: <geef data op wanneer endpoints verouderd zijn of worden>
Vervangende Endpoints: <lijst nieuwe endp ...
try_prompt
generate_helper
disclaimerOnPageApi
tags
ai_answers
provider: openai
model: gpt-4.1-nano
openapi: 3.0.3
info:
title: Gebruikersbeheer API
version: '2.0'
description: >
Deze API beheert gebruikersgegevens. Bepaalde endpoints worden verouderd en zullen op 1 juni 2024 worden uitgefaseerd. Gebruik de vervangende endpoints voor nieuwe integraties.
contact:
name: API Beheer Team
email: api-beheer@voorbeeld.com
servers:
- url: https://api.voorbeeld.com
description: Productie server
security:
- OAuth2PasswordFlow: []
components:
securitySchemes:
OAuth2PasswordFlow:
type: oauth2
flows:
password:
tokenUrl: https://auth.voorbeeld.com/oauth/token
scopes: {}
paths:
/v1/get-gebruiker:
get:
summary: Haal gebruikersinformatie op
description: >
**Let op:** Dit endpoint is verouderd en wordt op 1 juni 2024 uitfaseerd.
Gebruik in plaats daarvan: `/v2/gebruikers/{id}`.
deprecated: true
responses:
'200':
description: Gebruikersgegevens
'410':
description: Endpoint is verouderd en niet meer beschikbaar vanaf 1 juni 2024.
/v1/update-gebruiker:
put:
summary: Werk gebruikersinformatie bij
description: >
**Let op:** Dit endpoint is verouderd en wordt op 1 juni 2024 uitgefaseerd.
Gebruik in plaats daarvan: `/v2/gebruikers/{id}/update`.
deprecated: true
responses:
'200':
description: Update geslaagd
'410':
description: Endpoint is verouderd en niet meer beschikbaar vanaf 1 juni 2024.
/v2/gebruikers/{id}:
get:
summary: Haal gebruikersinformatie op (nieuw)
description: |
Dit is het vervangende endpoint voor het ophalen van gebruikersgegevens.
parameters:
- in: path
name: id
required: true
schema:
type: string
description: ID van de gebruiker
responses:
'200':
description: Gebruikersgegevens
'404':
description: Gebruiker niet gevonden
/v2/gebruikers/{id}/update:
put:
summary: Werk gebruikersinformatie bij (nieuw)
description: |
Dit is het vervangende endpoint voor het bijwerken van gebruikersgegevens.
parameters:
- in: path
name: id
required: true
schema:
type: string
description: ID van de gebruiker
requestBody:
description: Gegevens om bij te werken
required: true
content:
application/json:
schema:
type: object
properties:
naam:
type: string
email:
type: string
activeer:
type: boolean
responses:
'200':
description: Update succesvol
'404':
description: Gebruiker niet gevonden
# Vervangingsbeleid:
# - De endpoints /v1/get-gebruiker en /v1/update-gebruiker worden op 1 juni 2024 uitfaseerd.
# - Ontwikkelaars worden geadviseerd om over te schakelen naar de nieuwe endpoints onder /v2.
# - De verouderde endpoints bevatten "deprecated: true" en een beschrijving met vervangingsinformatie.
provider: deepseek
model: deepseek-chat
```yaml
openapi: 3.0.3
info:
title: Gebruikersbeheer API
description: |
API voor het beheren van gebruikersgegevens.
**Verouderingsbeleid:**
- Verouderde endpoints worden minimaal 6 maanden voor verwijdering aangekondigd
- Ontwikkelaars worden aangemoedigd om tijdig over te stappen naar nieuwe versies
- Verouderde functionaliteit wordt verwijderd in de eerstvolgende major release
version: 2.0.0
contact:
name: API Support
email: api-support@voorbeeld.nl
servers:
- url: https://api.voorbeeld.nl
description: Productie server
paths:
/v1/get-gebruiker:
get:
summary: Haal gebruiker op (VEROUDERD)
description: |
**DEPRECATED** - Deze endpoint is verouderd en wordt verwijderd op 2024-06-01.
**Vervanging:** Gebruik `/v2/gebruikers/{id}` in plaats daarvan.
Deze endpoint zal niet langer beschikbaar zijn na 2024-06-01.
deprecated: true
tags:
- Verouderd
security:
- OAuth2: [gebruikers.lezen]
parameters:
- name: gebruiker_id
in: query
required: true
schema:
type: string
description: ID van de op te halen gebruiker
responses:
'200':
description: Succesvolle response
'401':
description: Niet geautoriseerd
/v1/update-gebruiker:
post:
summary: Update gebruiker (VEROUDERD)
description: |
**DEPRECATED** - Deze endpoint is verouderd en wordt verwijderd op 2024-06-01.
**Vervanging:** Gebruik `/v2/gebruikers/{id}/update` in plaats daarvan.
Deze endpoint zal niet langer beschikbaar zijn na 2024-06-01.
deprecated: true
tags:
- Verouderd
security:
- OAuth2: [gebruikers.schrijven]
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GebruikerUpdate'
responses:
'200':
description: Succesvol bijgewerkt
'401':
description: Niet geautoriseerd
/v2/gebruikers/{id}:
get:
summary: Haal gebruiker op
description: Haal een specifieke gebruiker op basis van ID
tags:
- Gebruikers
security:
- OAuth2: [gebruikers.lezen]
parameters:
- name: id
in: path
required: true
schema:
type: string
description: Uniek ID van de gebruiker
responses:
'200':
description: Succesvolle response
content:
application/json:
schema:
$ref: '#/components/schemas/Gebruiker'
'404':
description: Gebruiker niet gevonden
/v2/gebruikers/{id}/update:
patch:
summary: Update gebruiker
description: Werk een gebruiker gedeeltelijk bij
tags:
- Gebruikers
security:
- OAuth2: [gebruikers.schrijven]
parameters:
- name: id
in: path
required: true
schema:
type: string
description: Uniek ID van de gebruiker
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GebruikerUpdate'
responses:
'200':
description: Succesvol bijgewerkt
content:
application/json:
schema:
$ref: '#/components/schemas/Gebruiker'
'404':
description: Gebruiker niet gevonden
components:
schemas:
Gebruiker:
type: object
properties:
id:
type: string
naam:
type: string
email:
type: string
aanmaakdatum:
type: string
format: date-time
GebruikerUpdate:
type: object
properties:
naam:
type: string
email:
type: string
securitySchemes:
OAuth2:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://api.voorbeeld.nl/oauth/authorize
tokenUrl: https://api.voorbeeld.nl/oauth/token
scopes:
gebruikers.lezen: Lees toegang tot gebruikersgegevens
gebruikers.schrijven: Schrijf toegang tot gebruikersgegevens
tags:
- name: Verouderd
description: |
**WAARSCHUWING:** Deze endpoints zijn verouderd en worden verwijderd op 2024-06-01.
Gebruik de bijbehorende v2 endpoints voor toekomstige ontwikkelingen.
- name: Gebruikers
description: Actuele endpoints voor gebruikersbeheer
```