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:
- OpenMRS.org
- Teknik yazar:
- batbrain7
- Projenin adı:
- OpenMRS REST API belgeleri
- Proje süresi:
- Standart uzunluk (3 ay)
Proje açıklaması
Teklifimi farklı bölümlere ayıracağım, Google Haritalar API'si dokümanları ve GitHub API dokümanları gibi akışı takip edeceğim.
Bunların dışında, realworld.io tarafından hazırlanan API dokümanları için bir benioku yapısı önermek istiyorum: https://github.com/gothinkster/realworld/tree/master/api
Şahsen bu belgenin anlaşılması ve kullanımının çok kolay olduğunu düşünüyorum.
Teklifim çoğunlukla 3 bölümden oluşur :
API'ye, OpenMRS'ye, API'nin nasıl kullanıldığına ve sonrasında neler olduğuna dair kısa bilgiler veren bir bölüm.
API isteğinde bulunmak için genel olarak gerekli olan API anahtarının ve kimlik doğrulamasının nasıl edinileceği. Bu çalışmada, API'de mevcut olan kimlik doğrulama türlerinin, bunun için bulunması gereken anahtar ve değerlerin yanı sıra söz konusu bölümdeki anahtara karşılık gelen kabul edilen değer türlerinin örnek bir örneği yer alacaktır. Herhangi bir dilde kod örneği kullanmak, API'de başlıkların, yanıt biçimlerinin ve diğer sorgu parametrelerinin nasıl yazılacağına yardımcı olur ve anlaşılır.
API tarafından getirilen yanıt türleri, JSON türleri veya API'ler tarafından döndürülen diğer sonuç türleri belirtilmelidir.
Farklı API rotaları ve tüm parametrelerin bunlarla birlikte gönderilmesi gereken başlıklar, başlıklar ve diğer öğeler. Her API, kendisi için kod yazılırken isteğin nasıl yapıldığını açıklayan birkaç dildeki kod örnekleriyle yardımcı olur. Her API'de karşılaşılabilecek genel hata kodları da belirtilmelidir.
Bu, belgelerin REST API için nasıl tanımlanacağına dair genel bir fikirdir.
Projenin zaman çizelgesi aşağıdaki gibidir :
1 Ağustos - 1 Eylül
Mentorumla tanışıp kod tabanının farklı bölümlerinde gerekli belgelerle ilgili daha ayrıntılı bilgi verebilir, aynı zamanda alt ve üst düzey belgelerde ne kadar derinlemesine gidileceğini tartışabilirsiniz. Bu zamanı kod tabanını anlamaya ve kavramları öğrenerek daha iyi belgelemeye de ayıracağım.
1. ve 2. Hafta
Katkıda bulunanlar kılavuzunu güncelleyip genişleteceğim. Kaynak kodun nasıl oluşturulacağıyla ilgili dokümanları geliştireceğim. Yeni katkıda bulunanların dokümanlarda nasıl yardımcı olabileceğiyle ilgili bir belgeselciler bölümü de ekleyeceğim. Farklı API belgelerini inceleyip giriş bölümüyle başlayacağım ve API kimlik doğrulamasını ekleyeceğim.
3. - 8. Hafta
Her API türü (benzer API türleri olabilir) için bazı kod örnekleriyle birlikte API rotalarını ve yanıtlarını ekleyeceğim.
9 ve 10. Hafta
Bağlantıları kullanarak API dokümanı yapılandırması ekleyin (uzun API belgeleri için bağlı bir dizin, yani kod bölümleri, genel bakış, parametreler, kök uç noktaları gibi farklı temellere göre bölme işlemi yapın).
Son Hafta
12 haftalık belgeleme dönemim boyunca yapılan çalışmaların nihai raporunu hazırlamak için son haftayı kullanacağım. Bu zamanı belgeleri inceleyip sonuçlandırmaya da ayıracağım.