در این مقاله ، من توضیح می دهم که چگونه با استفاده از SwagGo در Golang بلافاصله یک طرح اولیه API تولید کنید.
نقشه API سندی است که شامل چند نقطه پایانی API است ، کمی با اسناد یکسان است اما با توصیف کمتری. این اجازه می دهد تا یک برنامه نویس دیگر تمام نقاط پایانی موجود را بخواند و ببیند و آن را با ویژگی sandbox امتحان کند.
Swagger یکی از نقشه های پر کاربرد API در حال حاضر است که در استفاده های رایگان اما محدود در دسترس است. اگر می خواهید از اعتبار رایگان استفاده کنید ، باید نماد YAML را درک کنید ، می توانید نماد نمونه را در اسناد رسمی Swagger بخوانید. اما دوباره ، واقعاً دشوار است و برای تنظیم تمام علامت گذاری ها برای دستیابی به یک طرح خوب API ، زمان زیادی نیاز است.
خوشبختانه ، ابزارهایی در Golang وجود دارد که به ما امکان تولید نماد YAML را می دهد و فقط با استفاده از علامت گذاری نشانه ، صفحه طرح را به طور خودکار تولید می کند ، و برای خود میزبان رایگان است ، مجنون رایگان است؟
ابزار SwagGo در اینجا موجود است ، اسناد و مدارک کاملاً واضح است ، اما طبق تجربه من ، برای درک کامل نحوه استفاده از آن ، به زمان زیادی نیاز دارم. در اینجا می خواهم آنچه را که به دست آورده ام و آنچه را که اجرا کرده ام توضیح دهم.
این ابزارها از چارچوب های آشنا مانند پشتیبانی می کنند پژواک و جین ، اما در این آموزش ، من می خواهم از سرور وب پیش فرض استاندارد Go استفاده کنم.
پیش نیازها
همچنین می توانید از …