برای نوشتن یک سرویس در زی فریم مراحل زیر را به ترتیب انجام دهید.
ابتدا وارد برنامه زی فریم شوید.
در نوار ابزار بالا بر روی گزینه REST API List کلیک کنید تا وارد Web Api Manager شوید.
در این پنجره لیست تمام وب سرویس های نوشته شده در اپلیکیشن شما نمایش داده می شود. برای مثال در تصویر زیر یک وب سرویس با نام getallcourse نوشته شده است.
در پنجره باز شده (Web Api Manager) دکمه هایی برای مدیریت وب سرویس ها وجود دارد.
New Function: با استفاده از این دکمه می توان یک وب سرویس جدید ایجاد کرد.
Refresh: با استفاده از این دکمه میتوان لیست وب سرویس های موجود را بروزرسانی نمود تا اخرین تغییرات اعمال شده نمایش داده شود.
Test Api: با استفاده از این دکمه میتوان وب سرویس ها را مورد ازمایش و بررسی قرار داد.
Request Header: با استفاده از این دکمه می توان به Request Header های سرویس دسترسی داشت. به علاوه میتوان Request Header ها را ذخیره و یا بارگذاری کرد.
برای درک بهتر نحوه ایجاد و تست یک وب سرویس فرض کنید می خواهیم اطلاعاتی را با استفاده از یک سرویس به یکی از جداول موجود در دیتابیس وارد کنیم. در مرحله اول از قسمت نوار ابزار برنامه زی فریم گزینه Table Data را باز کنید.
سپس جدول مورد نظر خود را از پنجره DataBase Explorer انتخاب کنید تا اطلاعات مربوط به آن درون پنجره Table Data نشان داده شود. در این پنجره یک کوئری INSERT و UPDATE برای جدول انتخاب شده نوشته شده است.
کوئری INSERT را انتخاب کرده و آن را کپی کنید.
حال وارد پنجره Web Api Manager شده و بر روی دکمه New Function کلیک کنید تا پنجرهREST Function باز شود.
(در این پنجره گزینه ها و ابزارهای مختلفی برای مدیریت وب سرویس ها وجود دارد. برای آشنایی بیشتر با این ابزارها به مقاله معرفی ابزارهای REST Function مراجعه کنید.) در قسمت Function Name نام وب سرویس مورد نظر و در قسمت Base Url Address آدرس دلخواه برای آن را وارد کنید (در این مثال نام وب سرویس را Add و آدرس آن را در فولدر Person در نظر گرفتیم.)
سپس متد POST را در قسمت Call Method انتخاب کرده و کوئری INSERT که کپی کرده بودید را در قسمت Query قرار دهید.
حال بر روی گزینه Apply کلیک کنید تا تغییرات اعمال شود.
در پنجره Web Api Manager وب سرویس ساخته شده را انتخاب کنید. سپس در پنجره باز شده (REST Function) بر روی Test Api کلیک کنید تا پنجره Test Rest Api نمایش داده شود.
در این پنجره مقدار Url Address را کپی کنید.
حال وارد برنامه SoapUI شده و در نوار ابزار بالا بر روی گزینه REST کلیک کنید. با اینکار یک سرویس REST جدید ایجاد می شود.
آدرس کپی شده را در پنجره باز شده و در قسمت URL جایگذاری کرده و بر روی دکمه ok کلیک کنید.
بعد از این کار، پنجره Request 1 نمایش داده می شود. توجه کنید که متد موجود در برنامه SoapUI و متد انتخاب شده در وب سرویس زی فریم باید یکسان باشند. بنابراین در این قسمت نیز همانند وب سرویس ساخته شده در زی فریم، متد Post را انتخاب کنید.
در این مرحله نیاز به کد مناسبی برای وارد نمودن اطلاعات داریم. برای به دست اوردن این کد، وارد زی فریم شده و در پنجره Test Rest Api متن داخل قسمت Function Input را کپی کنید.
مقادیر کپی شده را مانند شکل زیر در برنامه SoapUI قرار دهید.
سپس اطلاعاتی که می خواهید به عنوان ورودی به سرویس دهید تا وارد جدول دیتابیس شوند را درون دابل کوتیشن ها (به جای علامت سوال) قرار دهید.
زمان اجرای وب سرویس است.
برای این کار بر روی دکمه که همان Submit request to specified endpoint URL است، کلیک کنید. بعد از اجرا شدن وب سرویس، اگر JSON را در نوار اجرا کننده انتخاب کنید، با پیام زیر مواجه خواهید شد.
که به معنای آن است که درخواست با موفقیت اجرا شده است.
حال به دیتابیس مراجعه کنید، مشاهده خواهید کرد که اطلاعات وارد شده، در دیتابیس با موفقیت قرار گرفته اند.
برای استفاده از وب سرویس ساخته شده (در مثال ذکر شده: وب سرویس ADD)، در فرم های زی فریم به صورت زیر عمل می کنیم.
در فرم PERSON یک دکمه قرار می دهیم تا با کلیک بر روی آن، اطلاعات وارد شده در فرم PERSON با استفاده از وب سرویس در جدول PERSON درون دیتابیس ذخیره شود (دقیقا همان کاری که درون Soap UI انجام دادیم، این بار با فرم های زی فریم انجام خواهد شد).
ابتدا با ایجاد یک ClientButton، یک دکمه به فرم ساخته شده توسط زی فریم اضافه کنید (برای یادگیری نحوه ایجاد یک کنترل جدید به آموزش روش ساخت و مدیریت کنترل ها در زی فریم مراجعه شود.) و در قسمت caption نام آن را "ذخیره" (و یا هر نام دلخواه دیگر) قرار دهید.
پس از ساخت یک دکمه جدید، به پنجره Web Api Manager باز گشته و سرویس ساخته شده (در این مثال add) را باز کنید.
سپس در پنجره REST Function بر روی دکمه JScript Code کلیک کنید تا پنجرهJava Script Call Function For REST API باز شود.
در این پنجره، وب سرویس به صورت یک کد جاوا اسکریپتی به کاربر ارائه می شود.
این کد را کپی کنید.
وارد بخشJava Script Code فرم مورد نظر خود (در این مثال فرم PERSON) شوید.
کد کپی شده را در این قسمت قرار دهید.
حالا کد جاوا اسکریپت زیر را به این قسمت اضافه کنید.
بر روی دکمه Save کلیک کنید تا کدهای جاوااسکریپت درون این فرم ذخیره شود.
در کنترل فرم PERSON بر روی دکمه ای که ساخته بودید کلیک راست کرده و از گزینه های نمایش داده شده Java Script Call Function را انتخاب کنید تا پنجره Java Script Events باز شود.
در قسمت Control Event List بر روی ایونت onclick دابل کلیک کرده تا کد onclick = “ ” در قسمت Java Script Function Call قرار گیرد. بین دابل کوتیشن نام تابع نوشته شده در جاوا اسکریپت (در این مثال FillParamAndSave) را نوشته و بر روی دکمه ok کلیک کنید.
حالا در خروجی نرم افزار، اطلاعات جدیدی در فرم "اشخاص" قرار داده و بر روی دکمه "ذخیره" کلیک کنید.
در صورتی که اطلاعات وارد شده در فرم، درون جدول PERSON موجود در دیتابیس قابل مشاهده باشند، دکمه و وب سرویس مربوط به آن به درستی ساخته شده اند.
همانطور که توسط یک وب سرویس توانستیم اطلاعات یک فرم را درون دیتابیس ذخیره کنیم، می توان اطلاعات موجود در دیتابیس را نیز با استفاده از یک وب سرویس دریافت کرد (برای یادگیری دریافت اطلاعات با استفاده از وب سرویس به آموزش دریافت داده به صورت JSON با استفاده از وب سرویس مراجعه شود).
گروه توسعه زیر ساخت نرم افزاری زی با نام تجاری Zframe، با بهره گیری از نیروهای متخصص و مجرب با رویکردی نوآورانه از سال 1387 فعالیت خود را آغاز و اقدام به تولید نرم افزار قدرتمند زی فریم نمود.
زی فریم به عنوان یک محصول نرم افزاری (DSL) در واقع همچون یک خط تولید نرم افزار است که با استفاده از آن می توان به سرعت، بدون نیاز به تسلط به دامنه وسیعی از تکنولوژی ها، یک نرم افزار مبتنی بر وب کارا، امن و یکپارچه تولید نمود.