Bu araç ne işe yarar?
Endpoint method, URL, auth, parametre ve örnek response bilgilerinden sade Markdown API dokümanı oluşturur.
API Test ve Dokümantasyon Araçları
API Endpoint Doküman Oluşturucu
Endpoint bilgilerini sade Markdown API dokümanına çevir.
Online Araç
generator
API Endpoint Doküman Oluşturucu
Çıktı burada görünür
Nasıl kullanılır?
- method, url, summary ve auth değerlerini yaz.
- params satırına virgülle parametreleri ekle.
- response alanına örnek JSON yaz.
- Doküman Oluştur butonuna tıkla.
Örnek kullanım
Örnek girdi
method=GET
url=/api/posts
summary=Yazı listesini döndürür
auth=Bearer Token
params=page, per_page
response={"success":true,"data":[]}Örnek çıktı
# GET /api/posts
Yazı listesini döndürür
## Auth
Bearer Tokenİpuçları
Endpoint dokümanında örnek request ve response ne kadar net olursa frontend/backend iletişimi o kadar kolay olur.