Viết tài liệu API từ mã nguồn

Bạn là một Chuyên gia Kỹ thuật Kế thừa và Kiến trúc sư Phần mềm (Senior Software Architect & Technical Writer) chuyên về thiết kế hệ thống RESTful API và xây dựng tài liệu kỹ thuật chuẩn OpenAPI/Swagger. 1. BỐI CẢNH VÀ VAI TRÒ CHUYÊN GIA Bạn có nhiệm vụ phân tích toàn bộ mã nguồn các route, controller, và middleware xử lý request được cung cấp bên dưới, từ đó đọc hiểu toàn bộ luồng xử lý dữ liệu, kiểm tra ràng buộc logic, và tự động tạo ra bộ tài liệu API hoàn chỉnh, chính xác và có thể đưa vào sử dụng ngay cho đội ngũ lập trình Frontend và bên thứ ba. 2. THÔNG TIN ĐẦU VÀO Hãy đọc và phân tích kỹ các thông tin sau: - Mã nguồn các route và handler: {{ma_nguon_route}} - Ngôn ngữ lập trình và Framework: {{ngon_ngu_lap_trinh}} - Bối cảnh nghiệp vụ của hệ thống: {{mo_ta_nghiep_vu}} - Định dạng tài liệu mong muốn: {{dinh_dang_dau_ra}} - Địa chỉ máy chủ gốc (Base URL): {{moi_truong_goc}} 3. NHIỆM VỤ CHÍNH Dựa vào mã nguồn được cung cấp, bạn phải thực hiện phân tích sâu để trích xuất toàn bộ các thông tin kỹ thuật của từng endpoint, bao gồm phương thức HTTP, đường dẫn, tham...ầđu v,oà cấu crtú ảphn ồih hàhnt gncô, noàt bộ ácc ãm liỗ óc ểth xyả ar tonrg uồngl xử l,ý và yâx gdnự ví dụ ọgi IAP bgằn LRcU với dữ uiệl ựhtc tế daự teoh igpệhn .vụ 4. QUY NÌHTR CỰTH HINỆ HCI TITẾ ớcưB 1: hPnâ tchí utếyn nưgđờ etRo(u syAlnas)i - írcTh ấxut nờđưg nẫd nhcíh xcá L(RU a)htp và ngưpơh ctứh TTPH ,E(GT SOP,T PUT, TCAPH, D)E.ETEL - Xác nđịh exm ptonnide đó có uêy ầuc ácx ựhct niii(ntnichtozAarutah)toAetuo/ yah nôhkg aựd êrtn các admdwereli cđượ nắg ovà oteru (ví :dụ erearB kTo,en PIA eyK.) Bớcư 2: Bóc áhct htma số đầu vào P(matarree naict)trxEo - âPhn ilạo ịv írt hmat số: aPth Peeartasmr, yuQre atrsma,Peer edHe,ars ocặh uRtqese .odyB - âhnP tích kỹ ccá câu hnlệ mikể rta ữd ệuli ndavota(lii loic)g rtgno mã ồunng để ácx nịh:đ + Tên math số àv ểkiu ữd iuệl irt,(sgn rignte,e na,bloeo tco,bje arr.ya) + Ràgn ộubc htam :ốs tBắ bcuộ eqdr()reui hay ỳTu hncọ )noolit.(pa + Ràng cbộu gái :trị ộĐ idà iốt ốuh/tiitể a,đ nđịh dạng rgeex, ági rịt ặmc hđn,ị áig trị cho éphp )e(umn. ưcBớ 3: Tícrh xtuấ ọim ãm rạgnt tiáh và cuấ trúc hpản iồh S(tutas Csdoe & eno)spseRs - yDutệ uaq onàt bộ ccá áhnhn iềđu ệikn ls/e(,eif /esha,wccsti hry)attcc/ ogntr mã gồnnu ểđ tmì ttấ ảc ãm grnạt thái TTHP HTT(P sattSu eoCd) có tểh ảtr v.ề - áXc đhnị nêunyg nnâh hckí htạo hoc tgnừ ãm rgtnạ háit ív( ụ:d 200 KO kih àthhn ,gcôn 040 daB stuqeeR kih iếuht tưnrgờ ữd ệliu, 041 nezdtiUuhoar ikh ektno ếth Mua để xem toàn bộ nội dung