Bu sayfa, Google Dokümanlar Sezonu için kabul edilen teknik yazı projesinin ayrıntılarını içerir.
Proje özeti
- Açık kaynak kuruluşu:
- Açık Yiyecekle İlgili Bilgiler
- Teknik yazar:
- FutureOfDocs
- Proje adı:
- Open Food Facts API'sini belgeleyin
- Proje süresi:
- Uzun süreli (5 ay)
Proje açıklaması
"Dokümanlar Sezonu"nu ilk kez, birkaç ay önce aldığım REST API belgeleriyle ilgili bir dersin öğretmeninden aldığım bir e-postadan duydum. Fikri çok sevmiş olsam da, bir projeye, yalnızca gerçekten onunla özdeşleştireceksem başvurmaya karar verdim. Normal işimin yanında yapacağım bir şeydi, yaparsam da eğlenceli ve anlamlı olmalıydı.
Open Food Facts'ın açıklamasını okuduğumda bu projeyi bulduğumu biliyordum. Egzersiz ve yemek yaparak vücuduma ve sağlığıma iyi bakmayı seviyorum. Beslenmenin mutlu bir yaşamın anahtarlarından biri olduğunu düşünüyorum. Hepimiz daha iyi seçimler yapabilmeliyiz. Bu da ancak kullandığımız yiyecekler ve kozmetikler hakkında yeterli bilgiye sahip olmamız durumunda mümkün olabilir. Open Food Facts'ın bu bilgileri kullanımınıza sunuyoruz. Bu muhteşem girişime katkıda bulunmak istiyorum.
Son üç yıldır süreç ve sürüm otomasyonunda uzmanlaşmış bir yazılım geliştirme şirketinde teknik yazar olarak çalışıyorum. Bunların yanı sıra, Swagger ile geliştiricilerin API istekleri üzerinden uygulamalarımızla iletişim kurmalarına olanak tanıyan bir REST API'si uyguladık. Geliştirme ekiplerinin istekler/yanıtlar için daha iyi açıklamalar yazmasına yardımcı oldum ve birlikte, müşterilerimizin hangi bilgileri açık ve kısa bir şekilde sağlamalarına ihtiyaç duyduğunu belirledik.
Mevcut Open Food Facts API sitesini inceliyorum ve dokümanları daha kullanıcı dostu hale getirmek için yeniden yapılandırıp geliştirebileceğimizi düşünüyorum (Genel, OKUMA, YAZMA sayfaları). Ayrıca, geliştirme ekipleriyle birlikte API belgelerini koddan otomatik olarak oluşturmak için bir yöntem oluşturmayı çok isterim (bu, zaman alır ve bu nedenle uzun süreli bir ortak çalışma yapılmasını öneriyorum).
Görünümün önemli olduğunu hepimiz biliyoruz ;) Bu nedenle, promosyon kullanıcı arayüzünü kullanıcı belgeleriyle uyumlu hale getirmek için REST API CSS ve logosunu da değiştirebiliriz.
Bu projede sizinle çalışmayı sabırsızlıkla bekliyorum.