Maak een Basale GraphQL Schema Documentatie
description
Met deze prompt kan de gebruiker snel overzichtelijke en begrijpelijke documentatie maken voor een basaal GraphQL schema, wat communicatie binnen het team en met gebruikers verbetert. Het maakt het makkelijker om de API te gebruiken en onderhouden, en voorkomt misverstanden en fouten door onduidelijke schema's.
prompt
Help me een eenvoudige en duidelijke documentatie te maken voor mijn basale GraphQL schema met de volgende informatie:
Projectdoel: <beschrijf het doel van mijn GraphQL API>
Belangrijkste Type Definities: <geef een overzicht van de hoofdtypen en velden>
Ond ...
try_prompt
generate_helper
disclaimerOnPageApi
tags
ai_answers
provider: openai
model: gpt-4.1-nano
# Documentatie voor GraphQL API
## Projectdoel
Deze API maakt het mogelijk om gebruikersaccounts en profielen te beheren. Hiermee kunnen gebruikersgegevens en berichten worden opgevraagd en aangepast.
## Belangrijkste Type Definities
### User
Een gebruiker met de volgende eigenschappen:
- **id**: Unieke identificatie van de gebruiker (ID)
- **naam**: Naam van de gebruiker (String)
- **email**: E-mailadres van de gebruiker (String)
### Post
Een bericht met de volgende eigenschappen:
- **id**: Unieke identificatie van het bericht (ID)
- **titel**: Titel van het bericht (String)
- **inhoud**: Inhoud van het bericht (String)
- **auteur**: De gebruiker die het bericht heeft geplaatst (User)
## Queries (Oproepen om gegevens op te halen)
### getUser(id: ID)
- **Description**: Haalt de gegevens van een gebruiker op basis van hun ID.
- **Parameter**: `id` – Het unieke ID van de gebruiker.
- **Retourneert**: Een `User` object.
### listPosts
- **Description**: Geeft een lijst van alle berichten.
- **Parameters**: Geen.
- **Retourneert**: Een lijst van `Post` objecten.
## Mutaties (Optioneel, voor het aanpassen van gegevens)
### createPost
- **Description**: Maakt een nieuw bericht aan.
- **Parameters**:
- `titel` (String): Titel van het bericht.
- `inhoud` (String): Inhoud van het bericht.
- `auteurId` (ID): ID van de gebruiker die het bericht plaatst.
- **Retourneert**: Het aangemaakte `Post` object.
### updateUser
- **Description**: Wijzigt de gegevens van een bestaande gebruiker.
- **Parameters**:
- `id` (ID): ID van de gebruiker die je wilt bijwerken.
- `naam` (String, optioneel): Nieuwe naam.
- `email` (String, optioneel): Nieuw e-mailadres.
- **Retourneert**: Het bijgewerkte `User` object.
---
## Samenvatting
Deze API biedt basisfunctionaliteiten voor het ophalen en aanpassen van gebruikers en berichten. Gebruik de queries voor het lezen van gegevens en de mutaties voor het maken en bijwerken van gegevens. Zo heb je een overzichtelijke en eenvoudige manier om je gebruikers- en berichtgegevens te beheren.
---
Heb je nog verdere vragen of wil je aanvullende details toevoegen?
provider: deepseek
model: deepseek-chat
# GraphQL API Documentatie - Gebruikersaccounts en Profielen
## 📋 Projectoverzicht
Deze GraphQL API biedt functionaliteiten voor het beheren van gebruikersaccounts en gebruikersprofielen. De API ondersteunt zowel het ophalen van gegevens (queries) als het aanpassen van gegevens (mutaties).
## 🏗️ Schema Type Definities
### User Type
```graphql
type User {
id: ID!
naam: String!
email: String!
}
```
### Post Type
```graphql
type Post {
id: ID!
titel: String!
inhoud: String!
auteur: User!
}
```
## 🔍 Ondersteunde Queries
### getUser
Haalt een specifieke gebruiker op basis van ID op.
**Parameters:**
- `id: ID!` (verplicht) - De unieke identifier van de gebruiker
**Voorbeeld:**
```graphql
query {
getUser(id: "123") {
id
naam
email
}
}
```
### listPosts
Haalt een lijst van alle posts op.
**Parameters:**
- Geen parameters vereist
**Voorbeeld:**
```graphql
query {
listPosts {
id
titel
inhoud
auteur {
id
naam
email
}
}
}
```
## ✏️ Ondersteunde Mutaties
### createPost
Maakt een nieuwe post aan.
**Verwachte parameters:**
- `titel: String!` (verplicht) - De titel van de post
- `inhoud: String!` (verplicht) - De inhoud van de post
- `auteurId: ID!` (verplicht) - ID van de auteur
**Voorbeeld:**
```graphql
mutation {
createPost(titel: "Mijn eerste post", inhoud: "Dit is de inhoud", auteurId: "123") {
id
titel
inhoud
auteur {
naam
}
}
}
```
### updateUser
Werkt gebruikersinformatie bij.
**Verwachte parameters:**
- `id: ID!` (verplicht) - ID van de bij te werken gebruiker
- `naam: String` (optioneel) - Nieuwe naam
- `email: String` (optioneel) - Nieuw emailadres
**Voorbeeld:**
```graphql
mutation {
updateUser(id: "123", naam: "Nieuwe Naam", email: "nieuw@email.com") {
id
naam
email
}
}
```
## 💡 Gebruikstips
1. **Verplichte velden** worden aangegeven met `!`
2. **Queries** zijn voor het ophalen van gegevens (read-only)
3. **Mutaties** zijn voor het aanmaken/bijwerken van gegevens
4. Alle queries en mutaties retourneren het betreffende type met de opgevraagde velden
## 🚀 Starten met de API
Gebruik een GraphQL client (zoals Apollo Client, Relay, of een eenvoudige HTTP POST request) om verbinding te maken met de API endpoint.
**Basis request format:**
```json
{
"query": "...",
"variables": { ... }
}
```
Deze documentatie wordt bijgewerkt naarmate er nieuwe functionaliteiten worden toegevoegd aan de API.