Add Comment to Controller

This commit is contained in:
Suphonchai Phoonsawat 2023-04-03 09:18:43 +07:00
parent 28a59edd3b
commit 9d2a0e913c
10 changed files with 49 additions and 5 deletions

Binary file not shown.

View file

@ -269,7 +269,7 @@ namespace BMA.EHR.Recruit.Service.Controllers
} }
/// <summary> /// <summary>
/// แสดงข้อมูลรอบการสอบแข่งขัน /// แสดงข้อมูลรอบการสอบแข่งขันเป็นรายการ
/// </summary> /// </summary>
/// <param name="id">รหัสรอบการสอบแข่งขัน</param> /// <param name="id">รหัสรอบการสอบแข่งขัน</param>
/// <returns></returns> /// <returns></returns>

View file

@ -9,7 +9,29 @@
ตัวอย่างในการเขียน api เพื่อทำการ upload file ตัวอย่างในการเขียน api เพื่อทำการ upload file
</summary> </summary>
<returns></returns> <returns></returns>
<response code="200">เมื่อทำการอ่านข้อมูลจาก Relational Database สำเร็จ</response> <response code="200">เมื่อทำการ upload สำเร็จ</response>
<response code="400">ค่าตัวแปรที่ส่งมาไม่ถูกต้อง</response>
<response code="401">ไม่ได้ Login เข้าระบบ</response>
<response code="500">เมื่อเกิดข้อผิดพลาดในการทำงาน</response>
</member>
<member name="M:BMA.EHR.Recruit.Service.Controllers.RecruitController.DeleteFile(System.Guid)">
<summary>
ตัวอย่างในการเขียน api เพื่อทำการ delete file
</summary>
<param name="id">รหัสไฟล์ในฐานข้อมูล</param>
<returns></returns>
<response code="200">เมื่อทำการ delete file สำเร็จ</response>
<response code="400">ค่าตัวแปรที่ส่งมาไม่ถูกต้อง</response>
<response code="401">ไม่ได้ Login เข้าระบบ</response>
<response code="500">เมื่อเกิดข้อผิดพลาดในการทำงาน</response>
</member>
<member name="M:BMA.EHR.Recruit.Service.Controllers.RecruitController.DownloadFile(System.Guid)">
<summary>
ตัวอย่างในการเขียน api เพื่อทำการ download file
</summary>
<param name="id">รหัสไฟล์ในฐานข้อมูล</param>
<returns></returns>
<response code="200">เมื่อทำการ download file สำเร็จ</response>
<response code="400">ค่าตัวแปรที่ส่งมาไม่ถูกต้อง</response> <response code="400">ค่าตัวแปรที่ส่งมาไม่ถูกต้อง</response>
<response code="401">ไม่ได้ Login เข้าระบบ</response> <response code="401">ไม่ได้ Login เข้าระบบ</response>
<response code="500">เมื่อเกิดข้อผิดพลาดในการทำงาน</response> <response code="500">เมื่อเกิดข้อผิดพลาดในการทำงาน</response>
@ -26,7 +48,7 @@
</member> </member>
<member name="M:BMA.EHR.Recruit.Service.Controllers.RecruitController.GetByIdAsync(System.Guid)"> <member name="M:BMA.EHR.Recruit.Service.Controllers.RecruitController.GetByIdAsync(System.Guid)">
<summary> <summary>
แสดงข้อมูลรอบการสอบแข่งขัน แสดงข้อมูลรอบการสอบแข่งขันเป็นรายการ
</summary> </summary>
<param name="id">รหัสรอบการสอบแข่งขัน</param> <param name="id">รหัสรอบการสอบแข่งขัน</param>
<returns></returns> <returns></returns>

View file

@ -9,7 +9,29 @@
ตัวอย่างในการเขียน api เพื่อทำการ upload file ตัวอย่างในการเขียน api เพื่อทำการ upload file
</summary> </summary>
<returns></returns> <returns></returns>
<response code="200">เมื่อทำการอ่านข้อมูลจาก Relational Database สำเร็จ</response> <response code="200">เมื่อทำการ upload สำเร็จ</response>
<response code="400">ค่าตัวแปรที่ส่งมาไม่ถูกต้อง</response>
<response code="401">ไม่ได้ Login เข้าระบบ</response>
<response code="500">เมื่อเกิดข้อผิดพลาดในการทำงาน</response>
</member>
<member name="M:BMA.EHR.Recruit.Service.Controllers.RecruitController.DeleteFile(System.Guid)">
<summary>
ตัวอย่างในการเขียน api เพื่อทำการ delete file
</summary>
<param name="id">รหัสไฟล์ในฐานข้อมูล</param>
<returns></returns>
<response code="200">เมื่อทำการ delete file สำเร็จ</response>
<response code="400">ค่าตัวแปรที่ส่งมาไม่ถูกต้อง</response>
<response code="401">ไม่ได้ Login เข้าระบบ</response>
<response code="500">เมื่อเกิดข้อผิดพลาดในการทำงาน</response>
</member>
<member name="M:BMA.EHR.Recruit.Service.Controllers.RecruitController.DownloadFile(System.Guid)">
<summary>
ตัวอย่างในการเขียน api เพื่อทำการ download file
</summary>
<param name="id">รหัสไฟล์ในฐานข้อมูล</param>
<returns></returns>
<response code="200">เมื่อทำการ download file สำเร็จ</response>
<response code="400">ค่าตัวแปรที่ส่งมาไม่ถูกต้อง</response> <response code="400">ค่าตัวแปรที่ส่งมาไม่ถูกต้อง</response>
<response code="401">ไม่ได้ Login เข้าระบบ</response> <response code="401">ไม่ได้ Login เข้าระบบ</response>
<response code="500">เมื่อเกิดข้อผิดพลาดในการทำงาน</response> <response code="500">เมื่อเกิดข้อผิดพลาดในการทำงาน</response>
@ -26,7 +48,7 @@
</member> </member>
<member name="M:BMA.EHR.Recruit.Service.Controllers.RecruitController.GetByIdAsync(System.Guid)"> <member name="M:BMA.EHR.Recruit.Service.Controllers.RecruitController.GetByIdAsync(System.Guid)">
<summary> <summary>
แสดงข้อมูลรอบการสอบแข่งขัน แสดงข้อมูลรอบการสอบแข่งขันเป็นรายการ
</summary> </summary>
<param name="id">รหัสรอบการสอบแข่งขัน</param> <param name="id">รหัสรอบการสอบแข่งขัน</param>
<returns></returns> <returns></returns>