Bu sayfa, Google Dokümanlar Sezonu için kabul edilen bir teknik yazı projesinin ayrıntılarını içerir.
Proje özeti
- Açık kaynak kuruluşu:
- Açık Yiyecek Bilgileri
- Teknik yazar:
- FutureOfDocs
- Projenin adı:
- Open Food Facts API'yi belgeleyin
- Proje süresi:
- Uzun süreli (5 ay)
Proje açıklaması
"Dokümanlar Sezonu"nu ilk olarak, birkaç ay önce REST API belgeleriyle ilgili bir dersin öğretmeninden gelen bir e-postadan duydum. Fikri çok sevdim ama bir projeye, kendimi gerçekten tanımlayabilseydim başvurmaya karar verdim. Normal işimin yanı sıra yaptığım bir şeydi. Bunu yaparsam 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 kozmetik ürünler hakkında yeterli bilgiye sahip olmamız durumunda mümkün. Open Food Facts, bu bilgileri elimizde tutuyor ve ben de bu muhteşem girişime katkıda bulunmak istiyorum.
Son üç yıldır süreç ve yayın otomasyonunda uzmanlaşmış bir yazılım geliştirme şirketinde teknik yazar olarak çalışıyorum. Bunların yanı sıra, geliştiricilerin API istekleri aracılığıyla uygulamalarımızla iletişim kurmalarına olanak tanıyan Swagger ile bir REST API uyguladık. Geliştirme ekiplerinin talepler/yanıtlar için daha iyi açıklamalar yazmalarına yardımcı oldum ve birlikte, müşterilerimizin bunları açık ve kısa bir şekilde sunmak için hangi bilgilere ihtiyaç duyduğunu belirledik.
Bir süredir 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 koddan API belgelerini otomatik olarak oluşturmak için bir yöntem oluşturmayı çok isterim (bu işlem zaman aldığı için uzun süreli bir ortak çalışma teklif ediyorum).
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.