2.0 KiB
2.0 KiB
Plant Names API
این API فقط لیست نام گیاهها را به همراه آیکون و مراحل رشد برمیگرداند.
Endpoint
GET /api/plants/names/
کاربرد
- گرفتن لیست سبک برای dropdown یا selector فرانت
- نمایش نام گیاه
- نمایش
icon - نمایش مراحل رشد هر گیاه
رفتار API
- فقط فیلدهای
name،iconوgrowth_stagesرا برمیگرداند - اگر
growth_stageبرای یک گیاه خالی باشد، API به صورت خودکار این مراحل پیشفرض را اضافه و در دیتابیس ذخیره میکند:initialvegetativefloweringfruitingmaturity
- اگر
iconخالی باشد، مقدار پیشفرضleafذخیره و برگردانده میشود - اگر در
growth_profile.stage_thresholdsمرحلهای وجود داشته باشد، آن مرحله هم در خروجیgrowth_stagesلحاظ میشود
نمونه درخواست
curl -X GET http://localhost:8000/api/plants/names/
نمونه پاسخ
{
"code": 200,
"msg": "success",
"data": [
{
"name": "Tomato",
"icon": "leaf",
"growth_stages": [
"vegetative",
"flowering",
"fruiting"
]
},
{
"name": "Pepper",
"icon": "leaf",
"growth_stages": [
"initial",
"vegetative",
"flowering",
"fruiting",
"maturity"
]
}
]
}
فیلدهای خروجی
name: نام گیاهicon: آیکون گیاه برای فرانتgrowth_stages: آرایهای از مراحل رشد گیاه
نکته برای فرانت
- این endpoint برای لیست سبک طراحی شده و مناسب صفحههای انتخاب گیاه است
- اگر جزئیات کامل گیاه لازم دارید، از
GET /api/plants/یاGET /api/plants/{id}/استفاده کنید