תיעוד אוטומטי של API

[אוהב להתווכח]

תיעוד אוטומטי של API

אני משתמש ב-WebApi ואני מאוד נהנה מזה שהוא מייצר לי תיעוד אוטמטי ל-API. אלו שצוריכם ממני את ה-API משתמשים בזה ונהנים.
מה שחסר לי זה איזו הערה שלפעמים נצרכת. יש שם עמודה Description אבל אני לא מצליח להבין מה ממלא אותה.
מצורף תמונה (שאני מקוה) שמסבירה מה אני רוצה.
תודה מראש לעונים.

 

[nocgod]

באיזה כלי אתה משתמש כדי לייצר את התיעוד הזה?

כשהשתמשתי ב swagger כדי לקבל תיאור ודברים יותר גרנולריים הייתי צריך להוסיף תיעוד XML מעל הactions (תיעוד /// לא סימפטי כזה)
אולי זה מה שיפתור לך את הבעיה

 

[אוהב להתווכח]

זה מגיע אוטומט בVS

פתחתי פרויקט webapi וקיבלתי דף help שכל הAPI נמצא שם.

 

[nocgod]

מעניין אף פעם לא קיבלתי כזה... אני אשלח לMS שנעלבתי

בכל מקרה תנסה להוסיף תיעוד באמצעות /// וספר אם עזר... אני אבדוק בהזדמנות את הכלי הזה שחידשת לי