API dokümantasyonu şart olmasına rağmen sürekli ikinci plana atılır. Sonuç: uç noktalar dokümantasyon olmadan yayınlanır, dokümantasyon gerçek API’den kopar ve yeni geliştiricilerin işe alışması olması gerekenden çok daha uzun sürer. Lodos API Documentation bunu, dokümanları doğrudan API Post/Get koleksiyonlarınızdan üreterek çözer - böylece dokümantasyon ve uygulama varsayılan olarak senkronize kalır.
Koleksiyondan Dokümantasyona Tek Tıkla
Uç noktalarınızı test etmek için zaten Lodos API Post/Get kullanıyorsanız, dokümantasyon üretmek çok kolaydır. API Documentation modülü koleksiyon yapınızı - uç noktalar, metotlar, başlıklar, istek gövdeleri ve yanıt örnekleri - okur ve otomatik olarak yapılandırılmış bir dokümantasyon sayfası üretir.
Sonuç şunları içerir:
- Metot rozetleriyle (GET, POST, PUT, DELETE) uç nokta listesi
- Tür ve açıklamalarla istek parametresi tabloları
- Örneklerle istek gövdesi şemaları
- Durum kodlarıyla yanıt örnekleri
- curl, JavaScript ve Python’da otomatik üretilen kod parçacıkları
Zengin Metin Düzenleme
Otomatik üretilen içerik nihai ürün değil, bir başlangıç noktasıdır. Zengin metin düzenleyici; bağlam, açıklamalar, kimlik doğrulama kılavuzları ve ham API yapısından çıkarılamayacak kavramsal genel bakışlar eklemenizi sağlar. Bunu %80 üretilmiş, %20 el işi olarak düşünün.
Sürüm Yönetimi
API’ler evrilir. Sürüm yönetimi sistemi, birden çok API sürümü için dokümantasyonu aynı anda tutmanıza olanak tanır. Her sürüm bağımsız olarak düzenlenebilir; sürümleri güncel, kullanımdan kaldırılmış veya eski olarak işaretleyebilirsiniz.
Paylaşım ve Dışa Aktarma
- Paylaşılabilir bağlantılar - çalışma alanı erişimi vermeden dokümantasyonu müşterilerle veya dış geliştiricilerle paylaşın
- PDF dışa aktarma - çevrimdışı dağıtım veya sözleşme dokümantasyonu için biçimlendirilmiş bir PDF üretin
- Ekip erişimi - hangi iş arkadaşlarının dokümantasyonu görüntüleyebileceğini veya düzenleyebileceğini kontrol edin
Dokümante Etmemenin Maliyeti
Geliştirici anketlerine göre, dokümante edilmemiş bir API’yle yeni tanışan bir geliştirici, davranışını tersine mühendislikle çözmek için ortalama 2-4 saat harcar. 3 dahili API’si olan 10 kişilik bir ekip için bu, her yeni işe alım başına 6-12 saatlik kaybedilmiş üretkenliktir. Dokümantasyon ilk işe alışta kendini amorti eder.
