API تحت NET. فارس‌نت

دانلود راهنمای استفاده از API فارس‌نت ۳

شما می توانید از طریق API تحت NET. به داده های شبکه واژگانی فارس‌نت در هر برنامه ویندوزی دسترسی پیدا کنید. جهت دانلود API بایستی در سایت Login نمایید. پس از ورود به سایت منو دانلودها برای شما فعال خواهد شد.

این واسط حاوی 3 فایل DLL و یک پایگاه داده SQLite3 می باشد. هیچ وابستگی دیگر برای آن وجود ندارد و همه نیازمندی ها در این فایلها تعبیه شده است.



البته فایل SQLite.Interop.dll شامل دو نسخه متفاوت ۳۲ و ۶۴ بیتی می باشد.



نحوه اضافه کردن به پروژه

با توجه به نوع محیط توسعه برنامه نویس می تواند با روش های مختلفی فایل ها را به برنامه اضافه کند. فایل پایگاه داده باید در root پروژه به عنوان یک فایل جانبی اضافه گردد و هنگام Build پروژه در کنار سایر خروجی های پروژه بدون هیچ فولدر بندی قرار گیرد.

در اینجا یک نمونه مثال برای محیط پر استفاده Visual Studio برای توسعه دهنده گان NET.ارائه می گردد.

1- بر روی پروژه Rightclick کنید و مسیر Add\ Reference انتخاب نمایید.

2- در این قسمت گزینه Browse را انتخاب کنید. سپس با کلیک بر روی کلید Browse دو فایل اصلی را جستجو کرده و به پروژه تان اضافه کنید. توجه داشته باشید که فایل SQLite.Interop.dll باید به صورت دستی به فولدر Bin یعنی فولدر خروجی برنامه اضافه شود و در اینجا نمی توانید آن را اضافه کنید.



3- بعد از اضافه کردن فایل Farsnet API نوبت به اضافه کردن فایل پایگاه داده می رسد. بر روی پروژه Rightclick کنید و مسیر Add \ Existing Item انتخاب نمایید.

4- سپس مسیر فایل پایگاه داده را جستجو و انتخاب کنید.



5- در نهایت خروجی پروژه به شکل زیر خواهد بود. در قسمت Properties مربوط به فایل پایگاه داده در قسمت Copy to output directory مقدار Copy always تنظیم نمایید.



نحوه استفاده در کد پروژه

بعد از اضافه کردن DLLها به پروژه بایستی با using کردن namespace های برنامه در کلاس NET. از آنها استفاده نمود.



برای شروع استفاده از API بایستی از کلاس SynsetService و SenseService استفاده نمود.

مطابق الگو زیر می توان از قابلیت ها و متدهای واسط برنامه نویسی فارس‌نت در محیط NET. بهره برد.



پارامتر SearchStyle در getSensesByWord یا getSynsetsByWord تعیین کننده نوع جستجو است و شامل مقادیر زیر است:

  • LIKE مقدار کلمه شامل searchKeyword باشد.
  • START مقدار کلمه با searchKeyword شروع شود.
  • END مقدار کلمه با searchKeyword خاتمه یابد.
  • EXACT مقدار کلمه دقیقا با searchKeyword برابر باشد