مستندات API

خروجی ژئوباکس‌سرور به صورت مجموعه‌ای از وب‌سرویس‌های کاملاً RESTful است، که توسعه‌دهندگان یا سایر نرم‌افزارها می‌توانند از طریق آن از تمامی امکانات ژئوباکس‌سرور استفاده کنند. این رابط براساس استاندارد OpenAPI مستندسازی شده و از طریق رابط‌های کاربر استاندارد Swagger  و Redoc در ژئوباکس پورتال در دسترس هستند. از طریق این رابط‌‌های کاربری می‌توان از تمامی ابزارها، منابع و پردازش‌‌های ژئوباکس پورتال به صورت RESTful استفاده کرد.

مستندات API در ژئوباکس پورتال

رابط کاربری Swagger

با کلیک بر روی OpenAPI صفحه زیر نمایش داده می‌شود که لیست انواع منابع و سرویس‌های ژئوباکس وجود دارد که با کلیک بر روی هر کدام لیست انواع درخواست‌های آن بخش نمایش داده می شود.

رابط کاربری OpenAPI

در مستندات API نام درخواست1، آدرس درخواست2، نوع درخواست3 نمایش داده شده است که با کلیک بر روی آن جزییات درخواست نمایش داده خواهد شد.

لیست درخواست‌ها در Open API

در جزییات درخواست اطلاعات درخواست شامل پارامترهای ورودی1، بدنه درخواست2، فرمت بدنه3، فرمت  پاسخ4 و همچنین مثال‌هایی از درخواست5 و پاسخ‌های موفق6 و ناموفق7 ارائه شده است. همچنین با کلیک بر روی Schema8 در جزییات درخواست، مشخصات پارامترهای بدنه و پاسخ شرح داده شده‌اند. جهت استفاده از درخواست‌ها از طریق رابط کاربری می‌توان بر روی Try it out9 کلیک کرد و با واردکردن پارمترهای مورد نیاز درخواست و کلیک بر روی Execute درخواست را ارسال و پاسخ آن را دریافت کرد.

صفحه اطلاعات درخواست در OpenAPI

مشخصات پارامترهای بدنه شامل فرمت1، پارامترهای اجباری2   ،مقادیر معتبر پارامترها3 و غیره می‌باشند.

مشخصات پارامترهای بدنه درخواست در OpenAPI

مثال: در تصویر زیر درخواست ایجاد یک لایه برداری  و همچنین پاسخ دریافت شده شامل مشخصات لایه برداری ایجاد شده نمایش داده شده است :

درخواست :

درخواست ایجاد لایه برداری با استفاده از OpenAPI

پاسخ:

پاسخ ایجاد لایه برداری با استفاده از OpenAPI

دیدگاه خود را ثبت نمایید

نشانی ایمیل شما منتشر نخواهد شد. بخش‌های موردنیاز علامت‌گذاری شده‌اند *