به روش های زیر می توان به Swagger دسترسی پیدا کرد:
- از طریق آدرس URL اختصاصی:پرشین ای پی آی یک آدرس وب (URL) خاص برای رابط کاربری Swagger UI منتشر می کند. این آدرس مرتبط با آدرس پایه API است و می‌تواند به یکی از اشکال زیر باشد:
[آدرس پایه API]/swagger/[آدرس پایه API]/api-docs/[آدرس پایه API]/docs/[آدرس پایه API]/swagger-ui/
این آدرس را در مرورگر خود وارد کرده و به رابط کاربری تعاملی Swagger UI دسترسی پیدا کنید.
- از طریق لینک در وب‌سایت ارائه‌دهنده: پرشین ای پی آی لینکی به مستندات API در بخش‌های مختلف مانند “Developers”، “API Documentation”، “Resources” یا موارد مشابه قرار داده. بر روی آن کلیک کند.
- از طریق پورتال توسعه‌دهندگان: یک پورتال اختصاصی برای توسعه‌دهندگان ارائه می شودشامل مستندات API، نمونه کدها، آموزش‌ها و ابزارهای مختلف است. مستندات Swagger UI در این پورتال در دسترس است.
- دریافت فایل OpenAPI Specification (JSON یا YAML): پرشین ای پی آی فایل OpenAPI Specification (با پسوند
.jsonیا.yaml) را در اختیار مشتری قرار دهد. مشتری می‌تواند این فایل را در یک ابزار Swagger UI محلی یا آنلاین (مانند ادیتور آنلاین Swagger) بارگذاری کند تا مستندات API را مشاهده و تست کند.