<\/div>\n

Merhaba,<\/p>\n

Bu i\u00e7eri\u011fimizde Restful servisler i\u00e7in olmazsa olmaz bir d\u00f6k\u00fcman arac\u0131 olan Swagger’i inceliyor olaca\u011f\u0131z. Swagger; web API uygulamalar\u0131nda endpointleri test etmek yahut server side uygulamalar\u0131na entegre olacak clientlara yard\u0131mc\u0131 olmak i\u00e7in uygulamadaki t\u00fcm endpointleri otomatik analiz edebilen ve bunlar\u0131n testi i\u00e7in hali haz\u0131rda bir aray\u00fcz olu\u015fturan developer dostu bir ara\u00e7t\u0131r. Hemen hemen her modern programlama dili ve ortam\u0131nda Swagger desteklenmektedir. <\/p>\n

Swagger, sistemdeki t\u00fcm endpointleri yakalayabilmek i\u00e7in t\u00fcm controller’lar ve i\u00e7lerindeki actionlar\u0131 bir .json format\u0131ndaki veri ile tutmakta ve bunu d\u00f6k\u00fcmantasyon i\u00e7in kullan\u0131lan Swagger-UI i\u015flevsel aray\u00fcz\u00fcne g\u00f6ndermektedir. B\u00f6ylece geli\u015fim s\u00fcrecindeki API uygulamas\u0131nda de\u011fi\u015fen yahut yeni eklenen t\u00fcm endpointler Swagger arac\u0131 sayesinde dinamik olarak yakalanabilmekte ve bu durumda bizler a\u00e7\u0131s\u0131ndan total maliyetten olduk\u00e7a k\u00e2r elde edilmektedir. Dolay\u0131s\u0131yla s\u00fcrekli geli\u015fen yahut de\u011fi\u015fen bir sistemi d\u00f6k\u00fcmante \u015fekilde tarif edebilmek s\u00fcrekli takip ve d\u00f6k\u00fcman g\u00fcncellemesi gerektirece\u011finden dolay\u0131 olduk\u00e7a yo\u011fun bir emek sarf etmemizi gerektirecektir. <\/p>\n

\u0130\u015fte Swagger, t\u00fcm bu emekleri do\u011fru yere sarf etmemiz ve enerjimizi do\u011fru yere y\u00f6nlendirmemiz i\u00e7in geli\u015ftirilmi\u015f bir yap\u0131lanmad\u0131r. T\u00fcm bunlar\u0131n yan\u0131nda d\u00f6k\u00fcmante \u00f6zelli\u011fiyle birlikte endpointleri sunmu\u015f oldu\u011fu Swagger-UI \u00fczerinden h\u0131zl\u0131ca test etmemizi sa\u011flayarak taktirleri katbekat hak etmeyi ba\u015farm\u0131\u015ft\u0131r.<\/p>\n

Kurulumu<\/h4>\n

Swagger arac\u0131n\u0131 kullanabilmek i\u00e7in ilk olarak i\u00e7in \u015fu<\/a> adresteki en g\u00fcncel s\u00fcr\u00fcm\u00fcn\u00fc istedi\u011finiz y\u00f6ntemle uygulamaya indiriniz. \u00d6rnek olarak bu i\u00e7eri\u011fin klavyeye al\u0131nd\u0131\u011f\u0131 anda en g\u00fcncel olarak bulunan “4.0.1” s\u00fcr\u00fcm\u00fcn\u00fc .NET CLI arac\u0131l\u0131\u011f\u0131yla a\u015fa\u011f\u0131daki kod sayesinde uygulamaya import ediyorum.<\/p>\n

\r\ndotnet add package Swashbuckle.AspNetCore --version 4.0.1\r\n<\/pre>\n<\/a><\/p>\n
Swashbuckle<\/em><\/strong> isimli k\u00fct\u00fcphanenin Swagger i\u00e7in otomatik UI \u00fcretilmesini sa\u011flayan bir sorumlulu\u011fu mevcuttur. <\/p>\n
Entegrasyonu<\/h4>\nBu i\u015flemden sonra Swagger arac\u0131n\u0131 uygulamaya entegre etmek i\u00e7in Startup dosyas\u0131nda “ConfigureServices” metodu i\u00e7erisinde “AddSwaggerGen” metodunu a\u015fa\u011f\u0131daki gibi kullan\u0131yoruz.<\/p>\n\r\n        public void ConfigureServices(IServiceCollection services)\r\n        {\r\n            .\r\n            .\r\n            .\r\n            services.AddSwaggerGen(_ => _.SwaggerDoc("docname", new Info { Title = "Doc Title", Version = "v1" }));\r\n            .\r\n            .\r\n            .\r\n        }\r\n<\/pre>\nYukar\u0131daki kod blo\u011funu incelerseniz e\u011fer uygulamaya Swagger k\u00fct\u00fcphanesi dahil edilmekte bununla beraber olu\u015fturulacak Swagger d\u00f6k\u00fcman\u0131n\u0131n temel konfig\u00fcrasyon ayarlar\u0131 sa\u011flanmaktad\u0131r.<\/p>\n
Bu i\u015flemden sonra servis olarak eklenen Swagger arac\u0131n\u0131, uygulaman\u0131n kullanmas\u0131 i\u00e7in yine Startup dosyas\u0131ndaki “Configure” metodu i\u00e7erisinden a\u015fa\u011f\u0131daki gibi ayarlamam\u0131z gerekmektedir.<\/p>\n\r\n        public void Configure(IApplicationBuilder app, IHostingEnvironment env)\r\n        {\r\n            .\r\n            .\r\n            .\r\n            app.UseSwagger();\r\n            app.UseSwaggerUI(_ => _.SwaggerEndpoint("\/swagger\/docname\/swagger.json", "Project Name"));\r\n            .\r\n            .\r\n            .\r\n        }\r\n<\/pre>\nBurada ise “UseSwagger” metodu ile uygulaman\u0131n Swagger arac\u0131n\u0131 kullanmas\u0131n\u0131, “UseSwaggerUI” metodu ile ise kullan\u0131lacak Swagger arac\u0131n\u0131n UI endpoint bilgilerini ayarlam\u0131\u015f bulunmaktay\u0131z. Muhtemelen g\u00f6z\u00fcn\u00fcze ili\u015fmi\u015ftir ama ben yinede ifade etmi\u015f olay\u0131m ki, “SwaggerEndpoint” fonksiyonu i\u00e7erisinde birinci olan “url” parametresi de\u011fer olarak yukar\u0131da tan\u0131mlanm\u0131\u015f olan Swagger d\u00f6k\u00fcman\u0131n\u0131n ad\u0131n\u0131 dizininde kullanmak zorundad\u0131r.<\/p>\n
Art\u0131k bu i\u015flemlerden sonra uygulamay\u0131 \u00e7al\u0131\u015ft\u0131r\u0131p https:\/\/localhost:****\/<\/span>swagger<\/strong> \u015feklinde bir istekte bulunursan\u0131z sizi Swagger ekran\u0131 kar\u015f\u0131layacakt\u0131r.<\/p>\n\u0130lgili ekran \u00fczerinden a\u015fa\u011f\u0131daki ekran g\u00f6r\u00fcnt\u00fcs\u00fcnde oldu\u011fu gibi uygulamadaki t\u00fcm endpointleri g\u00f6rebilir, onlar\u0131 deneyebilir, deneme sonucundaki verileri .json olarak elde edebilir ve bu \u015fekilde yap\u0131lanmay\u0131 tam teferruatl\u0131 d\u00f6k\u00fcmante etmi\u015f oluyoruz.
\n<\/a><\/p>\n
\u0130lgilenenlerin faydalanmas\u0131 dile\u011fiyle…
\nSonraki yaz\u0131lar\u0131mda g\u00f6r\u00fc\u015fmek \u00fczere…
\n\u0130yi \u00e7al\u0131\u015fmalar.<\/p>\n","protected":false},"excerpt":{"rendered":"
Merhaba, Bu i\u00e7eri\u011fimizde Restful servisler i\u00e7in olmazsa olmaz bir d\u00f6k\u00fcman arac\u0131 olan Swagger’i inceliyor olaca\u011f\u0131z. Swagger; web API uygulamalar\u0131nda endpointleri test etmek yahut server side uygulamalar\u0131na entegre olacak clientlara yard\u0131mc\u0131 olmak i\u00e7in uygulamadaki t\u00fcm...<\/p>\n","protected":false},"author":1,"featured_media":10888,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[2739,2832],"tags":[2841,2843,2844,2846,2842,2845,2847,2848,2849],"class_list":["post-10861","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-net-core","category-asp-net-core-2-2","tag-addswaggergen","tag-asp-net-core-swagger-araci","tag-asp-net-core-swagger-tool","tag-swagger","tag-swagger-araci","tag-swagger-tool","tag-swashbuckle","tag-useswagger","tag-useswaggerui"],"amp_enabled":true,"_links":{"self":[{"href":"https:\/\/www.gencayyildiz.com\/blog\/wp-json\/wp\/v2\/posts\/10861","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.gencayyildiz.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.gencayyildiz.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.gencayyildiz.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.gencayyildiz.com\/blog\/wp-json\/wp\/v2\/comments?post=10861"}],"version-history":[{"count":26,"href":"https:\/\/www.gencayyildiz.com\/blog\/wp-json\/wp\/v2\/posts\/10861\/revisions"}],"predecessor-version":[{"id":10890,"href":"https:\/\/www.gencayyildiz.com\/blog\/wp-json\/wp\/v2\/posts\/10861\/revisions\/10890"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/www.gencayyildiz.com\/blog\/wp-json\/wp\/v2\/media\/10888"}],"wp:attachment":[{"href":"https:\/\/www.gencayyildiz.com\/blog\/wp-json\/wp\/v2\/media?parent=10861"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.gencayyildiz.com\/blog\/wp-json\/wp\/v2\/categories?post=10861"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.gencayyildiz.com\/blog\/wp-json\/wp\/v2\/tags?post=10861"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}