راه های پیشنهادی برای مستند سازی REST API ها یا وب سرویس های REST

Question

برای مستند سازی REST API ها یا وب سرویس های REST بمنظور استفاده راحتتره توسعه دهندگانی که از آنها استفاده می کنند چه راه هایی را پیشنهاد می کنید؟

Answer 1

برای مستندسازی برای REST API ها Swagger جز بهترین ها می باشد که برای 25 زبان برنامه نویسی توسعه داده شده....مزیت این مستندساز این است که همیشه همراه پروژه شما می باشد و نیاز نیست در جای دیگری مدام آن را بروزرسانی نمائید. در مقاله زیر می توانید راهنمای استفاده از آن را در محیط ASP.NET WebAPI مشاهده کنید.

مستندسازی برای API ها توسط Swagger.

 

Answer 2

Swagger یک Framework مناسب برای REST API ها یا وب سرویس های REST است که یکی از مهمترین قابلیت های آن ارائه ابزار برای مستندسازی REST API ها یا وب سرویس های REST است.

Comments

امکانش هست یک نمونه در جاوا بزارید

---

تنظیمات Swagger  برای هر کدام از فریم ورک های جاوا متفاوت است. کدام فریم ورک مد نظر شما است؟