Örnek Çalışma - Muhtemelen şimdiye kadar gördüğünüz en güzel API belgelendirme web sitesi

Genel bakış

API belgelendirme hiçbir zaman eğlenceli olmamıştır. Genellikle tekdüze bir biçimde yazılan dosyaların sıkıcı bir şablona dönüştürülmesi ile başarılır. Ancak bunun için özelleşmiş farklı ve kullanışlı bir web sitesi ile bu sıkıcılığı eğlenceye dönüştürmek mümkündür.

Bu web sitesi güzel ve hızlı olmalıdır. Ayrıca kullanılan API'ı belgelendirmek için dosyalarda kullanılan veri biçimi kolayca okunup düzeltilebilir olmalıdır. Bu örnek çalışmada bunun için hem kolayca öğrenilebilen hem de esnek olan Markdown biçimini kullandık.

API belgelendirmek için özelleşmiş bir web sitesinde koyu ve açık mod desteği olması, kullanıcıların içeriği kolayca okuyabilmeleri için önemlidir. Böyle bir web sitesinde arama işlevselliği de çok önemlidir çünkü çoğu kullanıcı aradığını bulmak için bu işlevselliğe güvenir. Ayrıca kullanıcılardan geri bildirim almak da önemlidir. Böylece olası eksiklik ya da yanlışlar daha kısa zamanda fark edilip düzeltilebilir.

Örnek çalışmayı şuradan inceleyebilirsiniz: https://api.ismailarilik.com

Ne yaptık