Smile API Rest
این ماژول یک API در اختیار شما قرار می‌دهد که به شما امکان می‌دهد از طریق درخواست‌های HTTP به مدل‌ها دسترسی داشته باشید.
مستندات با استفاده از مشخصات Swagger OpenAPI - نسخه 2.0 ایجاد می‌شود (https://swagger.io/specification/v2/)
فهرست مطالب
نیازمندی‌ها
برای استفاده از این ماژول هیچ نیازی وجود ندارد.
دستورالعمل استفاده
آدرس مستندات
| آدرس | توضیحات |
|---|---|
| /<api-docs>/v<api_version> | مستندات API (تولید شده با Swagger) |
| /<api-docs>/v<api_version>/swagger.json | Swagger Json |
آدرس‌های API
| آدرس | روش | توضیحات |
|---|---|---|
| /<api>/v<api_version>/<api_name> | GET | خواندن همه (با دامنه، فیلدها، آفست، محدودیت، ترتیب اختیاری) |
| /api/v<api_version>/<api_name>/<id> | GET | خواندن یک (با فیلدهای اختیاری) |
| /api/v<api_version>/<api_name> | POST | ایجاد یک رکورد |
| /api/v<api_version>/<api_name>/<id> | PUT | به‌روزرسانی یک رکورد |
| /api/v<api_version>/<api_name>/<id> | DELETE | حذف یک رکورد |
| /api/v<api_version>/<api_name>/custom | PUT | فراخوانی متد (با پارامترهای اختیاری) |
| /api/v<api_version>/<api_name>/custom/<id> | PUT | فراخوانی متد روی رکورد (با پارامترهای اختیاری) |
پیگیری خطاها
خطاها در گیت‌هاب (GitHub Issues) پیگیری می‌شوند. در صورت بروز مشکل، لطفاً بررسی کنید که آیا مشکل شما قبلاً گزارش شده است یا خیر. اگر شما اولین نفری هستید که آن را مشاهده کرده‌اید، با ارائه بازخورد دقیق و مفید به ما کمک کنید تا آن را رفع کنیم اینجا.
لطفاً به طور مستقیم با مشارکت‌کنندگان برای پشتیبانی یا کمک در مسائل فنی تماس نگیرید.
اعتبارات
مشارکت‌کنندگان
- کورنتین پوئهت-برونری
- ژولین درک
- حمید میرزاپور
نگهدارنده
این ماژول توسط Smile SA نگهداری می‌شود.
از سال 1991، Smile پیشگام فناوری و همچنین کارشناس اروپایی در راه‌حل‌های متن‌باز بوده است.