آموزش مستندات API را با JSON و XML بیاموزید

سرفصل ها و درس ها

آشنایی با اسناد JSON و XML Introduction to JSON and XML Documentation

• خوش آمدی Welcome

• آنچه باید بدانید What you should know

• با استفاده از پرونده های تمرینی Using the exercise files

• چرا JSON و XML را مستند می کنیم؟ Why document JSON and XML?

• انواع داده ها و داده های ساخت یافته Data types and structured data

• ابزارهایی برای نوشتن JSON و XML Tools for writing JSON and XML

• علامت گذاری Markdown

• علامت گذاری به چالش کشیدن Markdown challenge

• راه حل علامت گذاری Markdown solution

1. JSON 1. JSON

• مبانی JSON JSON basics

• مثالهای JSON JSON examples

• ایجاد چالش JSON Create JSON challenge

• راه حل JSON ایجاد کنید Create JSON solution

• مستند سازی پاسخ های JSON در یک سطح Documenting one-level JSON responses

• مستند سازی پاسخ های JSON تو در تو Documenting nested JSON responses

• مستندسازی درخواستهای JSON Documenting JSON requests

• مستندسازی چالش JSON Documenting JSON challenge

• مستند سازی راه حل JSON Documenting JSON solution

2. XML 2. XML

• مبانی XML XML basics

• ویژگی ها و مثال های XML XML attributes and examples

• XML پیشرفته Advanced XML

• XML چالش XML challenge

• راه حل XML XML solution

• مستند سازی XML Documenting XML

• چالش اسناد XML XML documentation challenge

• راه حل اسناد XML XML documentation solution

3. ابزار 3. Tools

• ابزار برای اسناد داده های ساخت یافته Tools for structured data documentation

• استفاده از داده های ساختاری برای مستند سازی Using structured data for documentation

نتیجه Conclusion

• مراحل بعدی Next steps