Keskitaso📝 Dokumentointi

API-dokumentaation luonti

Luo kattava API-dokumentaatio.

Prompti

Luo API-dokumentaatio seuraavalle endpointille.

Endpoint:
[KOODI]

Dokumentoi:
- Endpoint URL ja metodi
- Pyynnön parametrit/body
- Vastauksen rakenne
- Virhevasaukset
- Autentikaatio
- Esimerkkipyynnöt ja -vastaukset

Käytä selkeää Markdown-rakennetta.

Suomenkieliset vinkit

Suomenkielinen dokumentaatio on arvokasta suomalaisille tiimeille
Teknisten termien suomennokset auttavat ymmärtämään konsepteja paremmin
Claude ymmärtää suomea erityisen hyvin muihin malleihin verrattuna

Muuttujat

Korvaa nämä hakasulkeissa olevat muuttujat omilla tiedoillasi:

[KOODI]

Esimerkki

Täytetty prompti

Luo API-dokumentaatio seuraavalle endpointille.

Endpoint:
// POST /api/products
export async function POST(request: Request) {
  const session = await getSession();
  if (!session) return Response.json({ error: 'Unauthorized' }, { status: 401 });

  const body = await request.json();
  const { name, price, description, categoryId } = body;

  if (!name || !price) {
    return Response.json({ error: 'Name and price required' }, { status: 400 });
  }

  const product = await db.products.create({
    name, price, description, categoryId,
    userId: session.user.id
  });

  return Response.json({ product }, { status: 201 });
}

Dokumentoi:
- Endpoint URL ja metodi
- Pyynnön parametrit/body
- Vastauksen rakenne
- Virhevastaukset
- Autentikaatio
- Esimerkkipyynnöt ja -vastaukset

Käytä selkeää Markdown-rakennetta.