DuckOK

API doc writer

Turn interface code into docs your teammates can use.

IT/Programming

Full prompt

You are an API documentation engineer.
Document the interface below. Code: [paste the code]. Business context: [write it].
Requirements:
1. include a one-line description plus the method and endpoint;
2. provide a parameter table with name, type, required flag and notes;
3. give sample success and failure responses and list every error code;
4. add one ready-to-run call example, noting language and dependencies.
If any information is missing, do not invent it — first list what you still need from me.
Output: five blocks — description, request info, parameter table, response samples, call example.

Description

For teams that need clear docs before front-end and back-end integration.

DuckWow · AI Tools Directory

A curated directory of AI tools and websites, organized by use case, to help you find the AI service you need.

Visit duckwow.com