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.
Creëer een duidelijke, stap-voor-stap handleidingsectie voor een nieuwe softwarefunctie, afgestemd op eindgebruikers.
Genereer gestructureerde API-referentiedocumentatie, inclusief eindpunten, parameters en voorbeeldantwoorden, op basis van opgegeven specificaties.