פרויקט OpenMRS.org
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
בדף הזה מופיעים הפרטים של פרויקט כתיבה טכנית שהתקבל בעונה של Docs ל-Google Docs.
סיכום הפרויקט
- ארגון קוד פתוח:
- OpenMRS.org
- כותבים טכניים:
- Ayeshmantha
- שם הפרויקט:
- פיתוח מסמכי תיעוד ב-GithHub ל-API ל-REST שידידותיים למשתמשים
- אורך הפרויקט:
- אורך רגיל (3 חודשים)
תיאור הפרויקט
המטרה העיקרית של הפרויקט היא לפתח תיעוד אינטראקטיבי שבו משתמשי הקצה יכולים ליצור אינטראקציה עם ממשקי ה-API עם אפשרויות להתנסות. בינתיים, לקבל תיאור תיאורי והסבר עצמי יותר שיסביר לאנשים הטכניים והלא טכניים באיזה מצב צריך להשתמש בנקודת הקצה.
סביבת ה-Swagger הנוכחית נהדרת, אבל גם לטכנאים וגם ללא טכנאים עדיין קשה לקבל מושג ישירות בלי תיעוד מתאים. הרעיון העיקרי הוא להציג את כל הסביבה והמסמכים של הראות במקום אחד כדי שיהיה ייצוג יפה. בעזרת JS, HTML ו-CSS.
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-07-25 (שעון UTC).
[null,null,["עדכון אחרון: 2025-07-25 (שעון UTC)."],[],["The project aims to improve the OpenMRS.org REST API documentation by creating an interactive environment where users can test APIs. The core objective is to make the documentation more accessible to both technical and non-technical users. This will involve integrating the existing Swagger environment with descriptive documentation, including \"try out\" options. The project will use JS, HTML, and CSS to create a user-friendly interface and enhance the presentation of the API documentation. The project will last three months.\n"],null,[]]
