# رابط برنامه نویسی اپلیکیشن
# تعریف و طریق استفاده
رابط برنامه نویسی اپلیکیشن (API) یو سی ام اس با استفاده از تکنولوژی گراف کی یو ال (GraphQL) در حال کامل شدن میباشد و در حال حاظر در قسمت ماژول اخبار به مرحله قابل استفاده ای رسیده است که با استفاده از این داکیومنت میتوانید استفاده های اولیه وابتدایی را داشته باشید همچنین در آینده امکان Mutation به api نیز اضافه میشود در حال حاظر تنها کاربرد آن در fetch کردن داده است در صورت سوال و یا مشکل با پشتیبانی تماس حاصل فرمایید .
تیم فنی معماران عصر ارتباط .
برای استفاده از api باید از Query های گراف کی یو ال استفاده کنید . برای از آنجایی که بستر وب برای تست ای پی ای فعلا موجود نیست (Playground) میتوانید برای تست از گزینه هایی مانند زیر استفاده کنید در ادامه نمونه و مثال هایی همراه با عکس خواهید دید .
# اخبار
اطلاعات مربوط به Api ماژول اخبار
# پارامتر ها
| پارامتر | توضیح |
|---|---|
| id | شناسه خبر |
| title | عنوان خبر |
| primaryImage {url} | آدرس عکس اصلی خبر |
| secondaryImage {url} | آدرس عکس ثانویه خبر |
| link | لینک |
| summary | خلاصه خبر |
| isCommentAllowed | بولین کامنت گذاری خبر |
| file {url} | آدرس فایل خبر |
| newsList | دسته اخبار |
| content | محتوای خبر |
| createdAt | تاریخ ایجاد خبر |
| rating | امتیاز خبر |
| hitCount | تعداد بازدید خبر |
| headline | روتیتر خبر |
| publishedAt | تاریخ انتشار |
# مثال ها
درعکس زیر نمونه ای از نحوه Query زدن توسط گراف کی یو ال رو میبینیم برای آشنایی بیشتر با این تکنولوژی لطفا داکیومنت اصلی رو بخوانید معماران عصر ارتباط وظیفه ای در قبال انتقال اطلاعات در باره چگونگی خود GraphQL ندارد .
# اسکرین شات
در عکس زیر نمونه ای از نحوه دریافت اطلاعات با استفاده از پارامتر های اخبار و به کمک اپلیکیشن پست من میبینیم .
# خدمات
بزودی تست
آپپپدیت
# پارامتر ها
بزودی
# مثال ها
بزودی