مشخصات اوپن‌ای‌پی‌آی
OpenAPI Specification
استانداردی رایج برای نوشتن قرارداد ای‌پی‌آی به شکلی که هم انسان و هم ماشین بتوانند آن را بخوانند.
مشخصات OpenAPI استانداردی باز و رایج برای توصیف ای‌پی‌آی‌های وب است. در یک فایل OpenAPI مسیرها، پارامترها، شکل داده‌ها، پاسخ‌ها، خطاها و روش امنیتی هر درخواست نوشته می‌شود.
چون این فایل ماشین‌خوان است، از روی آن می‌توان مستندات درگاه توسعه‌دهنده را ساخت، کیت توسعه تولید کرد، درخواست‌ها را اعتبارسنجی کرد و حتی سندباکس ساده راه انداخت. به بیان دیگر، OpenAPI شکل مکتوب و رسمی قرارداد ای‌پی‌آی است و منبع واحد حقیقت برای همه ابزارهای اطراف آن.
قسمت صوتی این واژه در ۲۹ اسفند ۱۴۰۵ در «یک دقیقه با ایران اوپن فاینانس» منتشر می‌شود.
واژه‌های مرتبط
قرارداد ای‌پی‌آیAPI contractتوافق دقیق درباره شکل درخواست‌ها، پاسخ‌ها و خطاهای یک ای‌پی‌آی که هر دو طرف به آن پایبندند.درگاه توسعه‌دهندهDeveloper portalوب‌سایتی که مستندات، کلید دسترسی، محیط آزمایشی و راهنمای استفاده از ای‌پی‌آی‌ها را یک‌جا در اختیار برنامه‌نویسان می‌گذارد.کیت توسعه نرم‌افزارSDK (Software Development Kit)بسته‌ای از کد آماده که کار با یک ای‌پی‌آی را در یک زبان برنامه‌نویسی ساده‌تر می‌کند.نسخه‌بندی ای‌پی‌آیAPI versioningروشی برای تغییر دادن ای‌پی‌آی بدون خراب کردن برنامه‌هایی که از نسخه قبلی استفاده می‌کنند.