OpenMRS.org projesi

Bu sayfada, Google Dokümanlar Sezonu için kabul edilen bir teknik yazım projesinin ayrıntıları yer almaktadır.

Proje özeti

Açık kaynak kuruluşu:
OpenMRS.org
Teknik yazar:
Ayeshmantha
Projenin adı:
REST API için Kullanıcı Dostu GitHub Dokümanları Geliştirme
Proje uzunluğu:
Standart uzunluk (3 ay)

Proje açıklaması

Projenin birincil amacı, son kullanıcıların deneme seçenekleriyle API'lerle etkileşim kurabileceği ve aynı zamanda teknik ve teknik olmayan kullanıcılara uç noktanın hangi durumlarda kullanılması gerektiğini açıklayan daha açıklayıcı ve kendi kendini açıklayan bir doküman geliştirmek.

Mevcut swagger ortamı harika ancak teknolojiyle ilgili olmayanlar ve teknolojiyle ilgili olanlar için uygun dokümanlar olmadan doğrudan fikir edinmek hâlâ zor. Ana fikir, bu havalı ortamı ve belgeleri iyi bir temsille tek bir yerde tutmaktı. JS, HTML ve CSS'nin yardımıyla.