მეგა-პრომპტი · პროგრამირება და ტექნოლოგიები
REST API-ის დიზაინი
კარგად დაპროექტებული API-ის გამოყენება ადვილია და შეცვლა უსაფრთხო. ეს მეგა-პრომპტი API-ს კოდის წერამდე აპროექტებს, თანმიმდევრული წესებით და მზა OpenAPI სპეციფიკაციით.
## როლი შენ ხარ senior backend დეველოპერი და API არქიტექტორი. ## კონტექსტი - რისთვის არის API: [აღწერა] - ვინ გამოიყენებს: [საკუთარი ფრონტენდი / მობილური აპი / გარე პარტნიორები / საჯარო] - ძირითადი ერთეულები: [მაგ.: მომხმარებელი, შეკვეთა, პროდუქტი] - ძირითადი ოპერაციები: [ჩამოთვალე] - ავტორიზაციის მოთხოვნები: [როლები, ვის რა შეუძლია] - ტექნოლოგია: [მაგ.: Node.js, Laravel, Django, FastAPI] - მოსალოდნელი დატვირთვა: [დაახლოებით] ## შექმენი 1. **რესურსების მოდელი** — რესურსები, მათი ველები და ურთიერთკავშირები. 2. **ენდპოინტების ცხრილი** — მეთოდი, გზა, აღწერა, ავტორიზაცია, წარმატების კოდი. 3. **სქემები** — ძირითადი ენდპოინტების მოთხოვნისა და პასუხის JSON მაგალითები. 4. **კონვენციები** — სახელები (მრავლობითი რიცხვი, kebab / snake case), ფილტრაცია, დალაგება, პაგინაცია, ველების შერჩევა, თარიღების ფორმატი, Unicode / ქართული ტექსტი. 5. **შეცდომები** — ერთიანი შეცდომის ფორმატი, HTTP კოდების ცხრილი, ვალიდაციის შეცდომების მაგალითი. 6. **უსაფრთხოება** — ავტორიზაციის მეთოდი, უფლებების შემოწმება რესურსის დონეზე, rate limiting, ვალიდაცია, CORS, საიდუმლო მონაცემების დაცვა. 7. **იდემპოტენტურობა** — სადაც საჭიროა (მაგ.: გადახდები). 8. **ვერსიონირება** — სტრატეგია და როგორ შევცვალო API მომხმარებლების „გატეხვის“ გარეშე. 9. **OpenAPI 3** — სპეციფიკაცია YAML ფორმატში ძირითადი ენდპოინტებისთვის. 10. **ტესტირება** — რა უნდა დაიტესტოს თითოეულ ენდპოინტზე. ## წესები - თანმიმდევრულობა ყველაფერზე მნიშვნელოვანია. - არ გამოიყენო ზმნები URL-ში, თუ ეს REST-ის ლოგიკას არღვევს (გამონაკლისები ახსენი).
როგორ გამოვიყენოთ
- დააკოპირეთ პრომპტი ღილაკით „კოპირება“.
- ჩასვით ChatGPT-ში, Claude-ში ან Gemini-ში.
- კვადრატულ ფრჩხილებში მოცემული ადგილები შეცვალეთ საკუთარი ინფორმაციით.
- გაგზავნეთ და, საჭიროების შემთხვევაში, სთხოვეთ შედეგის დაზუსტება ან გადაკეთება.
რჩევები უკეთესი შედეგისთვის
- OpenAPI სპეციფიკაციიდან შეგიძლიათ ავტომატურად დააგენერიროთ დოკუმენტაცია და კლიენტის კოდი.
- API-ის დიზაინი ფრონტენდ-დეველოპერს კოდის წერამდე აჩვენეთ: ის მაშინვე დაინახავს, რა აკლია.
ხშირად დასმული კითხვები
რა არის იდემპოტენტური მოთხოვნა?
ეს არის მოთხოვნა, რომლის რამდენჯერმე გაგზავნა იგივე შედეგს იძლევა, რაც ერთხელ. მაგალითად, გადახდის მოთხოვნა უნდა იყოს იდემპოტენტური, რომ ქსელის შეფერხების გამო ორჯერ გაგზავნისას თანხა ორჯერ არ ჩამოიჭრას.
მსგავსი პრომპტები
- მონაცემთა ბაზის სქემის დიზაინიმეგა-პრომპტი, რომლითაც AI დააპროექტებს რელაციური მონაცემთა ბაზის სქემას: ერთეულები, კავშირები, ნორმალიზაცია, ინდექსები, შეზღუდვები, CREATE TABLE ბრძანებები და ტიპური მოთხოვნები.
- საკუთარი აპლიკაციის უსაფრთხოების მიმოხილვამეგა-პრომპტი დეველოპერებისთვის: AI ჩაატარებს თქვენი აპლიკაციის საფრთხეების მოდელირებას (threat modeling), გამოავლენს სუსტ ადგილებს და შეადგენს დაცვის პრიორიტეტულ გეგმას.
- ძველი კოდის მიგრაციის გეგმამეგა-პრომპტი, რომლითაც AI დაგეგმავს ძველი სისტემის მიგრაციას ახალ ტექნოლოგიაზე ან ვერსიაზე: ინვენტარიზაცია, რისკები, ეტაპობრივი სტრატეგია, ტესტირება და უკან დაბრუნების გეგმა.