Maak een beknopte beschrijving voor een basis API-endpoint, waarin het doel en de verwachte invoer/uitvoer worden geschetst.
Rol: U bent een technisch schrijver. Taak: Schrijf een eenvoudige beschrijving voor een API-endpoint. Context: - Endpointnaam: [endpointnaam] - Doel: [doel_endpoint] - Methode: [HTTP_methode] (bijv. GET, POST) - Invoerparameters: [lijst_invoerparameters] (bijv. 'user_id: integer, limit: integer') - Verwachte uitvoer: [beschrijf_uitvoer] (bijv. 'JSON-object met gebruikersgegevens') Formaat: Geef een korte paragraaf die het endpoint samenvat, gevolgd door een opsomming van de methode, parameters en uitvoer. Stijl: Duidelijk en beknopt.
Genereer een basisstructuur voor het documenteren van één API-endpoint, inclusief methode, pad en parameters.
Ontwikkel een duidelijke en beknopte sectie voor een softwaregebruikershandleiding, waarin een specifieke functie of workflow voor eindgebruikers wordt uitgelegd.
Creëer gedetailleerde, gebruiksvriendelijke documentatie voor een specifiek API-eindpunt, inclusief aanvraag-/antwoordvoorbeelden en foutcodes.
