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

Interactive documentation for Dasht API version 104, built with Swagger UI. This repository hosts the static files necessary to publish comprehensive API documentation through GitHub Pages, providing developers with an intuitive interface to explore endpoints, test requests, and understand request/response schemas.
https://github.com/pourjanali/dasht-api-docs

accounting accounting-api accounting-software api dasht documentation erp-api github-pages openapi rest-api sepidar sepidar-system static-docs swagger-ui web-service

Last synced: 2 months ago
JSON representation

Interactive documentation for Dasht API version 104, built with Swagger UI. This repository hosts the static files necessary to publish comprehensive API documentation through GitHub Pages, providing developers with an intuitive interface to explore endpoints, test requests, and understand request/response schemas.

• Host: GitHub
• URL: https://github.com/pourjanali/dasht-api-docs
• Owner: pourjanali
• License: mit
• Created: 2025-12-22T10:42:20.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2025-12-22T11:13:43.000Z (6 months ago)
• Last Synced: 2025-12-23T22:25:00.940Z (6 months ago)
• Topics: accounting, accounting-api, accounting-software, api, dasht, documentation, erp-api, github-pages, openapi, rest-api, sepidar, sepidar-system, static-docs, swagger-ui, web-service
• Language: CSS
• Homepage: https://pourjanali.github.io/dasht-api-docs/
• Size: 507 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# مستندات 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:

   ```bash

   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 ارسال نمایید.