JIPRAKS Classroom

Cara Bangun AI Agent Auto-Generate Dokumentasi API dengan n8n + GPT (MVP 2 Hari)

· 3 menit baca

Bangun AI Agent Auto-Generate Dokumentasi API dengan n8n + GPT (MVP 2 Hari)

🔧 Hook: Dokumentasi API yang selalu ketinggalan?

Anda pernah menghabiskan berjam‑jam menulis OpenAPI spec atau markdown tiap kali menambah endpoint? Tim dev jadi terhambat, konsumen API kebingungan, dan proses onboarding melambat. Masalah ini bukan soal kurangnya skill menulis, melainkan kurangnya otomatisasi yang terintegrasi dengan workflow pengembangan. Bayangkan jika setiap perubahan kode otomatis menghasilkan dokumentasi yang rapi, up‑to‑date, dan siap dipublish – tanpa menulis satu baris lagi.

💡 Konsep Singkat: AI Agent + n8n = Dokumentasi Instan

AI Agent adalah worker yang mengeksekusi prompt LLM (misalnya OpenAI GPT‑4o) untuk menghasilkan teks berdasar input struktural. n8n, sebagai orkestrator low‑code, menghubungkan webhook, Git, dan layanan storage. Kombinasi keduanya memungkinkan:

  • Detect perubahan pada repository (GitHub webhook).
  • Extract metadata endpoint (route, method, param, response) lewat parser kode.
  • Prompt GPT untuk menulis deskripsi, contoh request/response, dan guidelines.
  • Publish ke repo docs atau ke platform seperti ReadMe, Swagger UI, atau GitBook.

Semua ini dapat selesai dalam 2 hari MVP dengan sedikit kode JavaScript di dalam node n8n.

🛠️ Breakdown Teknis Workflow

  1. Trigger: GitHub Push Event
    • Gunakan node GitHub Trigger (event: push) pada branch main.
    • Filter hanya file *.js/*.ts yang berada di folder /src/routes.
  2. Parse Endpoint
    • Node Function dengan acorn (AST parser) untuk mengekstrak path, method, parameter type, dan response schema.
    • Output JSON: {path, method, params, response}.
  3. Enrich dengan OpenAI
    • Node HTTP Request ke https://api.openai.com/v1/chat/completions.
    • Prompt template: 
      You are a technical writer. Write a concise OpenAPI‑compatible markdown documentation for the following endpoint:
Path: {{path}}
Method: {{method}}
Parameters: {{params}}
Response schema: {{response}}
Provide:
- Summary (max 2 kalimat)
- Parameter table
- Example request JSON
- Example response JSON
- Notes / error handling
    • Set temperature=0.2 for deterministic output.
  4. Store Dokumentasi
    • Node Write Binary File → folder docs/api/{{method}}_{{slug_path}}.md.
    • Opsional: Commit kembali ke repo dengan GitHub node (action: create commit).
  5. Deploy / Notify
    • Jika menggunakan ReadMe, panggil POST /api/v1/docs untuk refresh.
    • Kirimi tim Slack notifikasi New API docs generated for {{path}}.

🚀 Use Case Real: SaaS Billing Service

Tim FinPay memiliki 30 endpoint billing (create‑invoice, refund, subscription‑list). Sebelumnya mereka menulis dokumentasi manual di Swagger UI, menghabiskan 2‑3 hari tiap sprint. Dengan workflow di atas:

  • Setiap PR yang mengubah /src/routes/billing/*.ts otomatis memicu n8n.
  • Dalam 30 detik, markdown baru muncul di folder docs/api dan Swagger UI ter‑refresh.
  • Hasil: 95% pengurangan effort dokumentasi, dan developer bisa langsung cek GET /docs/api untuk preview.

💡 Insight & Strategi Praktis

  • Prompt Engineering itu kunci – simpan template di variable n8n, gunakan placeholder sehingga tim dapat meng‑custom tanpa ubah workflow.
  • Cache hasil LLM – simpan hash dari {path,method,params,response}. Jika tidak berubah, lewati panggilan OpenAI untuk hemat biaya.
  • Versioning otomatis – tambahkan header komentar di file markdown dengan Generated‑at: {{timestamp}}. Ini memudahkan audit.
  • Human‑in‑the‑loop – tambahkan step “Approve in Slack” sebelum commit ke repo utama, sehingga reviewer masih dapat memvalidasi.
  • Skalabilitas – ketika endpoint >100, gunakan n8n SplitInBatches untuk paralel processing, dan limit rate‑limit OpenAI dengan Throttle node.

📝 Penutup & Call to Action

Dengan kombinasi n8n dan GPT, dokumentasi API tidak lagi menjadi beban. Cukup set webhook, parser, dan prompt, Anda memiliki mesin yang menulis sendiri setiap kali kode berubah. Daftar di JIPRAKS Classroom untuk akses template workflow lengkap, demo project, dan komunitas developer yang sudah membangun AI Agent serupa.

Mulailah hari ini: fork repo contoh, pasang webhook GitHub, dan lihat dokumentasi Anda ter‑generate secara otomatis dalam hitungan menit!

Artikel terkait