Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Subject: Request for API Documentation |نیاز به مستندات API #4166

Open
amanjmoezi opened this issue Jun 3, 2024 · 2 comments
Open

Comments

@amanjmoezi
Copy link

سلام hiddify

مشکل اینجاست که برای API مستندسازی دقیقی موجود نیست،در پنل هم به خوبی کار نمیکنه، و اینکه درک کامل از قابلیت‌ها، پارامترها، و نحوه استفاده ازش یکم دشوار بوده. این عدم وضوح باعث کند شدن فرآیند کارم شده و کار رو کمی غیر بهینه کرده.

آیا میشه یه مستندات جامعی ارائه بدید که همه جنبه‌های API رو شامل شه؟ چیزایی مثل:

هدف و عملکرد API و نحوه کارش
توضیحات دقیق از نقاط پایانی، متدها و پارامترها
نمونه‌های درخواست و پاسخ
چطوری احراز هویت انجام میشه
چیکار باید بکنیم اگر خطا پیش بیاد
هرگونه محدودیت یا سیاست‌های استفاده
سعی کردم خودم سعی کنم با تحلیل ترافیک شبکه و مهندسی معکوس نقاط پایانی، چیزی رو درست کنم، ولی خب کمی سخت بود. داشتن مستندات معتبر و کامل واقعاً به سرعت فرآیند کارم رو بالا میبره و مطمئن میشم که API رو به درستی استفاده می‌کنم.

میشه با این موضوع کمکم کنید؟ دسترسی به مستندات جامع واقعاً کمک زیادی به من میکنه. اگه نیاز به اطلاعات بیشتری یا هرگونه کمک دیگه‌ای از سمت من دارید، فقط کافیه بهم بگید.

ممنون از بررسی این درخواست!

با احترام،
امانج معزی
برنامه‌نویس وب

@amanjmoezi amanjmoezi changed the title Subject: Request for API Documentation | موضوع : درخواست برای api داکیومنتشن Subject: Request for API Documentation | درخواست برای api داکیومنتشن Jun 3, 2024
@amanjmoezi amanjmoezi changed the title Subject: Request for API Documentation | درخواست برای api داکیومنتشن Subject: Request for API Documentation |نیاز به مستندات API Jun 3, 2024
@Iam54r1n4
Copy link
Contributor

Iam54r1n4 commented Jun 5, 2024

این یک خلاصه ای درباره ی API های هیدیفای هست:
API document on website

اما برای اینکه درک بهتری از API ها پیدا کنید، باید از چنین مسیری رو طی کنید:
پنل ادمین -> تنظیمات -> API

@amanjmoezi
Copy link
Author

بله هست اما هر کاری میکنم درخواست ها نامفهومه یا اینکه درست در نمیاد یا اینکه ۴۰۱ در میاد

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants