مستندات API دشت | Dasht API Docs

[English]
This repository hosts the static files required to display the Dasht API documentation using Swagger UI. These documents are published via GitHub Pages for easy and interactive access to the API endpoints.

[فارسی]
این ریپازیتوری شامل فایل‌های استاتیک مورد نیاز برای نمایش مستندات API دشت با استفاده از Swagger UI است. این مستندات برای دسترسی آسان‌تر و تعاملی به اندپوینت‌های API، از طریق GitHub Pages منتشر شده است.

🔗 مشاهده مستندات | View Documentation

You can view the interactive API documentation here:
برای مشاهده مستندات تعاملی روی لینک زیر کلیک کنید:

🚀 https://pourjanali.github.io/dasht-api-docs

🛠 نحوه استفاده | How to Use

1. مرور آنلاین (Online Browsing)

Simply visit the GitHub Pages link to explore the API, test endpoints, and view schemas.
کافیست به لینک GitHub Pages مراجعه کنید تا API را بررسی کرده، اندپوینت‌ها را تست کنید و اسکیماها را مشاهده نمایید.

2. اجرای محلی (Local Usage)

If you want to run this documentation locally:
اگر می‌خواهید این مستندات را به صورت لوکال اجرا کنید:

1. Clone the repository:

   git clone https://github.com/pourjanali/dasht-api-docs.git

2. Open index.html in your browser.
   فایل index.html را در مرورگر خود باز کنید.

📄 فایل منبع | Source File

The core OpenAPI definition is located at:
فایل اصلی تعریف OpenAPI در مسیر زیر قرار دارد:

dasht-api.json

🤝 مشارکت | Contributing

If you find any issues or have suggestions for the API documentation, please open an issue or submit a pull request.
اگر مشکلی در مستندات پیدا کردید یا پیشنهادی دارید، لطفاً یک Issue باز کنید یا Pull Request ارسال نمایید.