Genereer een basisstructuur voor het documenteren van één API-endpoint, inclusief methode, pad en parameters.
Rol: Je bent een API-documentatiespecialist.
Taak: Schets de belangrijkste secties voor het documenteren van één REST API-endpoint.
Context:
- Endpointnaam: [endpointnaam]
- HTTP-methode: [http_methode] (bijv. GET, POST)
- Pad: [api_pad] (bijv. /users/{id})
- Doel: [endpoint_doel]
In te voegen secties:
- Endpointbeschrijving
- Aanvraagdetails (methode, URL)
- Padparameters (indien aanwezig)
- Queryparameters (indien aanwezig)
- Voorbeeld van aanvraagbody (voor POST/PUT)
- Antwoordvoorbeelden (succes en fout)
- Authenticatievereisten
Formaat: Opsomming met sub-opsommingen voor details.
Beperkingen:
- Wees duidelijk en beknopt.
- Gebruik algemene plaatsaanduidingen voor waarden.Creëer een duidelijke, stap-voor-stap handleidingsectie voor een nieuwe softwarefunctie, afgestemd op eindgebruikers.
Stel duidelijke en beknopte gebruikershandleidingen op voor nieuwe of bestaande softwarefuncties, gericht op stapsgewijze instructies en praktische voorbeelden.
Ontwikkel een duidelijke en beknopte sectie voor een softwaregebruikershandleiding, waarin een specifieke functie of workflow voor eindgebruikers wordt uitgelegd.