---
term: "مشخصات اوپن‌ای‌پی‌آی"
english: "OpenAPI Specification"
category: "اوپن فاینانس و API"
url: https://iranopenfinance.com/glossary/openapi
source: Iran Open Finance (ایران اوپن فاینانس) glossary
---

# مشخصات اوپن‌ای‌پی‌آی (OpenAPI Specification)

> استانداردی رایج برای نوشتن قرارداد ای‌پی‌آی به شکلی که هم انسان و هم ماشین بتوانند آن را بخوانند.

مشخصات OpenAPI استانداردی باز و رایج برای توصیف ای‌پی‌آی‌های وب است. در یک فایل OpenAPI مسیرها، پارامترها، شکل داده‌ها، پاسخ‌ها، خطاها و روش امنیتی هر درخواست نوشته می‌شود.

چون این فایل ماشین‌خوان است، از روی آن می‌توان مستندات [درگاه توسعه‌دهنده](/glossary/developer-portal) را ساخت، [کیت توسعه](/glossary/sdk) تولید کرد، درخواست‌ها را اعتبارسنجی کرد و حتی [سندباکس](/glossary/sandbox) ساده راه انداخت. به بیان دیگر، OpenAPI شکل مکتوب و رسمی [قرارداد ای‌پی‌آی](/glossary/api-contract) است و منبع واحد حقیقت برای همه ابزارهای اطراف آن.

Related: [قرارداد ای‌پی‌آی](https://iranopenfinance.com/glossary/api-contract.md)، [درگاه توسعه‌دهنده](https://iranopenfinance.com/glossary/developer-portal.md)، [کیت توسعه نرم‌افزار](https://iranopenfinance.com/glossary/sdk.md)، [نسخه‌بندی ای‌پی‌آی](https://iranopenfinance.com/glossary/api-versioning.md)