स्प्रिंग बूट में माइक्रोसर्विसेज के साथ शुरुआत करना

सभी को नमस्कार!

इस लेख में, हम कंसूल सेवाओं की रजिस्ट्री, सभी मचानों के लिए स्प्रिंग बूट, निर्भरता इंजेक्शन, असेंबली के लिए मावेन, साथ ही स्प्रिंग रेस्ट और जावा रेस्टफुल जर्सी / जैक्सआरएस एपीआई का उपयोग करके रेस्टफुल माइक्रोसर्विसेज बनाने के लिए बुनियादी घटकों का प्रदर्शन करेंगे।

Microservices के मुख्य लाभ:

• माइक्रोसॉफ़्ट आपके कोड को ढीला करने में मदद करते हैं

• माइक्रोसॉफ़्ट विभिन्न टीमों को स्वतंत्र तकनीकों का उपयोग करके छोटे घटकों पर काम करने की अनुमति देता है, एक अधिक सुरक्षित और लगातार तैनाती प्रदान करता है। स्प्रिंग बूट एक REST API बनाने के लिए विभिन्न कार्यान्वयन का समर्थन करता है।

• सेवाओं की खोज और कॉल सेवा प्लेटफॉर्म पर निर्भर नहीं करती है

• स्वैगर मजबूत एपीआई प्रलेखन और कॉल इंटरफ़ेस बनाता है

यदि आप पहले से ही माइक्रोसर्विसेज का उपयोग नहीं कर रहे हैं, तो आप सफलतापूर्वक प्रौद्योगिकी धारणा वक्र पर शुरुआती अनुयायियों के चरण में आने में कामयाब नहीं हुए हैं, और यह शायद शुरू करने का सही समय है।



पिछले दो दशकों में, हमारी SDLC प्रक्रिया में कंपनी बहुत लचीली हो गई है, लेकिन एक नियम के रूप में, हमारे अनुप्रयोग, अभी भी अखंड हैं, विशाल जार के साथ सभी विभिन्न एपीआई और बाजार पर संस्करणों का समर्थन करते हैं। लेकिन वर्तमान में, अधिक लीन, DevOps प्रक्रियाओं की इच्छा है, और कार्यक्षमता "सर्वरहीन" हो रही है। माइक्रोसर्विस के लिए रिफ़ॉर्म करने से कोड और संसाधनों के उलझाव को कम किया जा सकता है, असेंबली को छोटा किया जा सकता है, अधिक सुरक्षित रिलीज़ किया जा सकता है, और एपीआई अधिक स्थिर हो सकते हैं।

इस लेख में, हम एक सरल स्टॉक मार्केट पोर्टफोलियो प्रबंधन एप्लिकेशन बनाएंगे जिसे ग्राहक अपने स्टॉक पोर्टफोलियो (स्टॉक टिकर और वैल्यू) का मूल्यांकन करने के लिए कॉल कर सकते हैं। पोर्टफोलियो माइक्रोसॉर्फ़ ग्राहक के पोर्टफोलियो को पुनः प्राप्त करेगा, इसे नवीनतम कीमतों को लागू करने के लिए मूल्य निर्धारण माइक्रोसॉर्स्ट को भेजें, और फिर पूरी तरह से मूल्यांकन और सबटोटलाइज़ किए गए पोर्टफोलियो को लौटाएं, बाकी कॉल के माध्यम से यह सब प्रदर्शित करता है।



इससे पहले कि हम अपने माइक्रोसर्विस बनाने पर काम शुरू करें, आइए, कंसुल की स्थापना करके अपना वातावरण तैयार करें।

कंसल डाउनलोड करें

हम सेवाओं की खोज के लिए हैशिकॉर्प कंसल का उपयोग करेंगे, इसलिए www.consul.io/downloads.html पर जाएं और विंडोज, लिनक्स, मैक आदि के लिए कंसल डाउनलोड करें। यह आपको एक निष्पादन योग्य फ़ाइल प्रदान करेगा जिसे आपको अपने पथ में जोड़ने की आवश्यकता है।

कौंसल लॉन्च करें

कमांड प्रॉम्प्ट पर, कॉन्सुल को देव मोड में लॉन्च करना:

consul agent -dev 

यह सत्यापित करने के लिए कि यह चल रहा है, अपने ब्राउज़र पर जाएं और कंसोल इंटरफ़ेस का उपयोग करें http: // localhost: 8500 । यदि सब ठीक हो जाता है, तो कौंसल को रिपोर्ट करना चाहिए कि वह जीवित है और अच्छी तरह से। कंसुल सेवा (बाईं ओर) पर क्लिक करके, आपको अतिरिक्त जानकारी प्राप्त होगी (दाईं ओर)।



यदि इस समय कोई समस्या है, तो सुनिश्चित करें कि आप कंसुल को निष्पादन पथ में जोड़ते हैं, और 8500 और 8600 पोर्ट उपलब्ध हैं।

एक स्प्रिंगबूट एप्लिकेशन का निर्माण करें

हमारे स्प्रिंगबूट एप्लिकेशन को मचान बनाने के लिए, हम स्प्रिंग प्रिविनिजर का उपयोग करेंगे, जो अधिकांश आईडीई में एकीकृत है। नीचे दिए गए स्क्रीनशॉट IntelliJ IDEA का उपयोग करते हैं।

एक नया प्रोजेक्ट टेम्प्लेट खोलने के लिए "फ़ाइल / नई परियोजना" चुनें, और फिर "स्प्रिंग प्रिन्टिज़र"।



सामान्य तौर पर, आप स्प्रिंगबूट इनिग्निज़्र वेब पेज start.spring.io के माध्यम से एक ऑनलाइन फॉर्म भरकर आईडीई के बिना मचान सेट कर सकते हैं, जो आपके खाली प्रोजेक्ट के लिए एक ज़िप फ़ाइल बनाएगा, जो डाउनलोड के लिए तैयार है।

"अगला" पर क्लिक करें और प्रोजेक्ट मेटाडेटा भरें। निम्नलिखित कॉन्फ़िगरेशन का उपयोग करें:



निर्भरता का चयन करने के लिए "अगला" पर क्लिक करें, और निर्भरता की खोज में "जर्सी" और "कंसल डिस्कवरी" दर्ज करें। इन निर्भरताओं को जोड़ें:



प्रोजेक्ट का नाम और उसके स्थान को इंगित करने के लिए "अगला" पर क्लिक करें। डिफ़ॉल्ट नाम "पोर्टफोलियो" रखें और परियोजना के पसंदीदा स्थान को निर्दिष्ट करें, फिर प्रोजेक्ट बनाने और खोलने के लिए "खत्म" पर क्लिक करें:



हम जेनरेट किए गए एप्लिकेशन का उपयोग कर सकते हैं। बेहतर तरीके से, लेकिन स्प्रिंगबूट भी YAML प्रारूप को पहचानता है, जिसे कल्पना करना थोड़ा आसान है, तो आइए इसका नाम बदलकर application.yml करें।

हम microservice को "पोर्टफोलियो-सेवा" कहते हैं। हम एक पोर्ट निर्दिष्ट कर सकते हैं या पोर्ट 0 का उपयोग कर सकते हैं ताकि एप्लिकेशन उपलब्ध पोर्ट का उपयोग कर सके। हमारे मामले में, हम 57116 का उपयोग करेंगे। यदि आप इस सेवा को डॉकटर कंटेनर के रूप में होस्ट करते हैं, तो आप इसे अपने द्वारा चुने गए किसी भी पोर्ट पर मैप कर सकते हैं। आवेदन का नाम और हमारे आवेदन के लिए निम्नलिखित जोड़कर हमारे बंदरगाह को निर्दिष्ट करें।

 spring: application: name: portfolio-service server: port: 57116 

हमारी सेवा उपलब्ध कराने के लिए, हमारे स्प्रिंगबूट एप्लिकेशन वर्ग में एनोटेशन जोड़ें। PortAppApplication एप्लिकेशन खोलें और वर्ग घोषणा के ऊपर @EnableDiscoveryClient जोड़ें।

आयात की पुष्टि करें। वर्ग को इस तरह दिखना चाहिए:

 package com.restms.demo.portfolio; import org.springframework.cloud.client.discovery.EnableDiscoveryClient; . . . @SpringBootApplication @EnableDiscoveryClient public class PortfolioApplication { public static void main(String[] args) { SpringApplication.run(PortfolioApplication.class, args); } } 

(यह प्रदर्शित करने के लिए कि माइक्रोसर्विस स्वतंत्र प्लेटफार्मों से कैसे जुड़ सकते हैं, हम इस सेवा के लिए जर्सी और अगले के लिए स्प्रिंग रेस्ट का उपयोग करेंगे)।
जर्सी पर रैस्टफुल वेब सेवा को कॉन्फ़िगर करने के लिए, हमें रिसोर्सकॉन्फ कॉन्फ़िगरेशन क्लास को निर्दिष्ट करने की आवश्यकता है। JerseyConfig क्लास जोड़ें (प्रदर्शन के लिए, हम इसे हमारे एप्लीकेशन क्लास के समान पैकेज में सहेजेंगे)। यह इस तरह दिखना चाहिए, साथ ही सही पैकेज और आयात:

 @Configuration @ApplicationPath("portfolios") public class JerseyConfig extends ResourceConfig { public JerseyConfig() { register(PortfolioImpl.class); } } 

ध्यान दें कि यह एक जर्सी विन्यास वर्ग के रूप में नामित करने के लिए ResourceConfig से विरासत में मिला है। @ApplicationPath ("पोर्टफोलियो") विशेषता कॉल के संदर्भ को परिभाषित करती है, जिसका अर्थ है कि कॉल "पोर्टफोलियो" पथ तत्व से शुरू होनी चाहिए। (यदि आप इसे छोड़ देते हैं, तो डिफ़ॉल्ट संदर्भ "/" है)।

PortIImpl वर्ग दो अनुरोधों को पूरा करेगा: पोर्टफोलियो / ग्राहक / {ग्राहक-आईडी} सभी पोर्टफोलियो और पोर्टफोलियो / ग्राहक / {ग्राहक-आईडी} / पोर्टफोलियो / {पोर्टफोलियो-आईडी} एक पोर्टफोलियो लौटाता है। एक पोर्टफोलियो में टिकर का एक सेट और उस टिकर द्वारा रखे गए शेयरों की संख्या शामिल होती है। (प्रदर्शन के लिए, पहचानकर्ता 0, 1 और 2 के साथ तीन ग्राहक हैं, जिनमें से प्रत्येक के पास पहचानकर्ता 0, 1 और 2 के साथ तीन पोर्टफोलियो हैं)।

आपका IDE आपको PortfolioImpl बनाने के लिए कहेगा; अभी करो। प्रदर्शित करने के लिए, इसे उसी पैकेज में जोड़ें। नीचे दिए गए कोड को दर्ज करें और सभी आयातों की पुष्टि करें:

 @Component @Path("/") public class PortfolioImpl implements InitializingBean { private Object[][][][] clientPortfolios; @GET @Path("customer/{customer-id}") @Produces(MediaType.APPLICATION_JSON) // a portfolio consists of an array of arrays, each containing an array of // stock ticker and associated shares public Object[][][] getPortfolios(@PathParam("customer-id") int customerId) { return clientPortfolios[customerId]; } @GET @Path("customer/{customer-id}/portfolio/{portfolio-id}") @Produces(MediaType.APPLICATION_JSON) public Object[][] getPortfolio(@PathParam("customer-id") int customerId, @PathParam("portfolio-id") int portfolioId) { return getPortfolios(customerId)[portfolioId]; } @Override public void afterPropertiesSet() throws Exception { Object[][][][] clientPortfolios = { { // 3 customers, 3 portfolios each {new Object[]{"JPM", 10201}, new Object[]{"GE", 20400}, new Object[]{"UTX", 38892}}, {new Object[]{"KO", 12449}, new Object[]{"JPM", 23454}, new Object[]{"MRK", 45344}}, {new Object[]{"WMT", 39583}, new Object[]{"DIS", 95867}, new Object[]{"TRV", 384756}}, }, { {new Object[]{"GE", 38475}, new Object[]{"MCD", 12395}, new Object[]{"IBM", 91234}}, {new Object[]{"VZ", 22342}, new Object[]{"AXP", 385432}, new Object[]{"UTX", 23432}}, {new Object[]{"IBM", 18343}, new Object[]{"DIS", 45673}, new Object[]{"AAPL", 23456}}, }, { {new Object[]{"AXP", 34543}, new Object[]{"TRV", 55322}, new Object[]{"NKE", 45642}}, {new Object[]{"CVX", 44332}, new Object[]{"JPM", 12453}, new Object[]{"JNJ", 45433}}, {new Object[]{"MRK", 32346}, new Object[]{"UTX", 46532}, new Object[]{"TRV", 45663}}, } }; this.clientPortfolios = clientPortfolios; } } 

घटक एनोटेशन इसे स्प्रिंग घटक के वर्ग के रूप में नामित करता है और इसे समापन बिंदु के रूप में उजागर करता है। वर्ग घोषणा के बारे में पथ एनोटेशन यह घोषणा करते हैं कि वर्ग को पथ तत्व "/" के माध्यम से एक्सेस किया गया है, और दो समर्थित एपीआई कॉल पोर्टफोलियो / ग्राहक / {ग्राहक-आईडी} और पोर्टफोलियो / ग्राहक / {ग्राहक-आईडी} / पोर्टफोलियो / {पोर्टफोलियो- के माध्यम से उपलब्ध हैं। आईडी}, जैसा कि हम विधि के एनोटेशन से देखते हैं। ध्यान दें कि पथ ("/") डिफ़ॉल्ट है, लेकिन हम इसे संदर्भ के लिए छोड़ देते हैं। तरीके @GETannotation के माध्यम से HTTP GET के रूप में नामित किए गए हैं। हमारा तरीका एक सरणी को वापस करने के लिए डिज़ाइन किया गया है और Json को वापस करने के लिए एनोटेट किया गया है, इसलिए यह Json सरणी लौटाता है। ध्यान दें कि कैसे पथ परम एनोटेशन प्रदर्शित प्रश्नों से प्रदर्शित मापदंडों को निकालने के लिए विधि हस्ताक्षर में उपयोग किए जाते हैं।

(हमारे डेमो के लिए, हम हार्डकोड मान लौटाते हैं। निश्चित रूप से, कार्यान्वयन डेटाबेस या किसी अन्य सेवा या डेटा स्रोत को हार्डकोड के बजाय क्वेरी करेगा।)
अब एक प्रोजेक्ट बनाएं और उसे चलाएं। यदि आप IntelliJ का उपयोग करते हैं, तो यह एक डिफ़ॉल्ट निष्पादन योग्य बना देगा, इसलिए बस हरे "रन" तीर पर क्लिक करें। आप भी इस्तेमाल कर सकते हैं

 mvn spring-boot:run 

या आप मावेन इंस्टॉलेशन कर सकते हैं और जावा -जर का उपयोग करके एप्लिकेशन को चला सकते हैं, जो टार्गेट डायरेक्टरी में जेनरेट किए गए जार की ओर इशारा करते हैं:

 java -jar target\portfolio-0.0.1-SNAPSHOT.jar 

अब हमें इस सेवा को कंसुल में देखना चाहिए, तो आइए अपने ब्राउज़र पर वापस जाएं, http: // localhost: 8500 / ui / # / dc1 / सेवाओं को डाउनलोड करें (या यदि आप पहले से मौजूद हैं तो अपडेट करें)।



हम्म, हम अपनी सेवा को वहां देखते हैं, लेकिन यह विफल के रूप में प्रदर्शित होता है। इसका कारण यह है कि कौंसुल हमारी सेवा से एक "स्वस्थ" दिल की धड़कन संकेत की उम्मीद करता है।
दिल की धड़कन के संकेतों को उत्पन्न करने के लिए, हम अपने एप्लिकेशन के पोम पर स्प्रिंग एक्ट्यूएटर सेवा पर निर्भरता जोड़ सकते हैं।

 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-actuator</artifactId> </dependency> 

जब हम पोम में होते हैं, तो ध्यान दें कि जर्सी के साथ कंसुल स्टार्टर और जर्सी स्टार्टर के बीच एक संस्करण संघर्ष है। इसे बाहर निकालने के लिए, जर्सी स्टार्टर को पहली लत के रूप में नामित करें।

आपके पोम में अब निम्नलिखित निर्भरताएँ होनी चाहिए:

 <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-jersey</artifactId> </dependency> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-consul-discovery</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-actuator</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency> </dependencies> 

कॉन्सल को फिर से शुरू करके, पोर्टफोलियो सेवा एक खुश प्रदर्शित करता है:



अब पोर्टफोलियो-सेवा में दो प्रसारण नोड हैं: उनमें से एक पोर्टफोलियो सेवा का हमारा कार्यान्वयन है, और दूसरा दिल की धड़कन है।

आइए उस पोर्ट की जांच करें जिसे असाइन किया गया है। आप आवेदन के आउटपुट में देख सकते हैं:

 INFO 19792 --- [ main] sbcetTomcatEmbeddedServletContainer : Tomcat started on port(s): 57116 (http) 

आप पोर्ट को सीधे कंसल यूजर इंटरफेस में भी देख सकते हैं। "ग्राहक-सेवा" पर क्लिक करें, फिर "सेवा 'ग्राहक-सेवा' चेक लिंक" लिंक का चयन करें, जो सेवा पोर्ट प्रदर्शित करता है, इस मामले में 57116।



अनुरोध http: // localhost: 57116 / पोर्टफोलियो / ग्राहक / 1 / पोर्टफोलियो / 2 और आप json सरणी देखेंगे [["IBM", 18343], ["DIS", 45673], ["AAPL", 23456]]

व्यापार के लिए हमारा पहला microservice खुला है!

मूल्य निर्धारण सेवा

अगला, हम अपनी मूल्य निर्धारण सेवा बनाएंगे, इस बार जर्सी के बजाय स्प्रिंग रेस्टकंट्रोलर का उपयोग करेंगे।

मूल्य निर्धारण सेवा ग्राहक पहचानकर्ता और पोर्टफोलियो पहचानकर्ता को मापदंडों के रूप में स्वीकार करेगी और पोर्टफोलियो सेवाओं का अनुरोध करने के लिए रीस्टेमप्लेट का उपयोग करेगी, टिकर और शेयर प्राप्त करेगी और वर्तमान मूल्य लौटाएगी। (मुझे आपको यह बताने की आवश्यकता नहीं है कि ये मूल्य नकली समाचार हैं, इसलिए व्यापारिक निर्णय लेने के लिए उनका उपयोग न करें!)

निम्नलिखित जानकारी का उपयोग करके एक नया प्रोजेक्ट बनाएं:



इस समय, वेब, कॉन्सल डिस्कवरी और एक्ट्यूएटर निर्भरता का चयन करें:



प्रोजेक्ट "मूल्य निर्धारण" का डिफ़ॉल्ट नाम छोड़ें और अपनी पसंद की निर्देशिका में प्रोजेक्ट बनाएं।

इस बार हम application.properties के बजाय application.yml का उपयोग करेंगे।
नाम और पोर्ट को अनुप्रयोग में सेट करें।

 spring.application.name=pricing server.port=57216 

@EnableDiscoveryClient के साथ मूल्य निर्धारण का उल्लेख करें। वर्ग को इस तरह दिखना चाहिए, प्लस पैकेज और आयात।

 @SpringBootApplication @EnableDiscoveryClient public class PricingApplication { public static void main(String[] args) { SpringApplication.run(PricingApplication.class, args); } } 

फिर हम PricingEndpoint क्लास बनाएंगे। यहां मैं एक अधिक विस्तृत उदाहरण दूंगा, क्योंकि यह कई महत्वपूर्ण कार्यों को प्रदर्शित करता है, जिसमें सेवा खोज (पोर्टफोलियो सेवा के लिए खोज) और क्वेरी के लिए RestTemplate का उपयोग करना शामिल है:

 @RestController @RequestMapping("/pricing") public class PricingEndpoint implements InitializingBean { @Autowired DiscoveryClient client; Map<String, Double> pricingMap = new HashMap<>(); RestTemplate restTemplate = new RestTemplate(); @GetMapping("/customer/{customer-id}/portfolio/{portfolio-id}") public List<String> getPricedPortfolio( @PathVariable("customer-id") Integer customerId, @PathVariable("portfolio-id") Integer portfolioId) { List<ServiceInstance> instances = client.getInstances("portfolio-service"); ServiceInstance instance = instances.stream() .findFirst() .orElseThrow(() -> new RuntimeException("not found")); String url = String.format("%s/portfolios/customer/%d/portfolio/%d", instance.getUri(), customerId, portfolioId); // query for the portfolios, returned as an array of List // of size 2, containing a ticker and a position (# of shares) Object[] portfolio = restTemplate.getForObject(url, Object[].class); // Look up the share prices, and return a list of Strings, formatted as // ticker, shares, price, total List<String> collect = Arrays.stream(portfolio).map(position -> { String ticker = ((List<String>) position).get(0); int shares = ((List<Integer>) position).get(1); double price = getPrice(ticker); double total = shares * price; return String.format("%s %d %f %f", ticker, shares, price, total); }).collect(Collectors.toList()); return collect; } private double getPrice(String ticker) { return pricingMap.get(ticker); } @Override public void afterPropertiesSet() throws Exception { pricingMap.put("MMM",201.81); pricingMap.put("AXP",85.11); pricingMap.put("AAPL",161.04); pricingMap.put("BA",236.32); pricingMap.put("CAT",118.02); pricingMap.put("CVX",111.31); pricingMap.put("CSCO",31.7); pricingMap.put("KO",46.00); pricingMap.put("DIS",101.92); pricingMap.put("XOM",78.7); pricingMap.put("GE",24.9); pricingMap.put("GS",217.62); pricingMap.put("HD",155.82); pricingMap.put("IBM",144.29); pricingMap.put("INTC",35.66); pricingMap.put("JNJ",130.8); pricingMap.put("JPM",89.75); pricingMap.put("MCD",159.81); pricingMap.put("MRK",63.89); pricingMap.put("MSFT",73.65); pricingMap.put("NKE",52.78); pricingMap.put("PFE",33.92); pricingMap.put("PG",92.79); pricingMap.put("TRV",117.00); pricingMap.put("UTX",110.12); pricingMap.put("UNH",198.00); pricingMap.put("VZ",47.05); pricingMap.put("V",103.34); pricingMap.put("WMT", 80.05); } } 

एक पोर्टफोलियो सेवा को खोजने के लिए, हमें डिस्कवरीक्लिक तक पहुंच की आवश्यकता है। स्प्रिंग के @Autowired एनोटेशन के साथ इसे प्राप्त करना आसान है।

 @Autowired DiscoveryClient client; 

यह डिस्कवरी क्लस्टर उदाहरण तब कॉल में सेवा की खोज करने के लिए उपयोग किया जाता है:

 List<ServiceInstance> instances = client.getInstances("portfolio-service"); ServiceInstance instance = instances.stream().findFirst().orElseThrow(() -> new RuntimeException("not found")); 

सेवा मिलने के बाद, हम अपने अनुरोध को पूरा करने के लिए इसका उपयोग कर सकते हैं, जिसे हम अपने पोर्टफोलियो सेवा में बनाए गए एपीआई कॉल के अनुसार बनाते हैं।

 String url = String.format("%s/portfolios/customer/%d/portfolio/%d", instance.getUri(), customerId, portfolioId); 

अंत में, हम अपने GET अनुरोध को निष्पादित करने के लिए RestTemplate का उपयोग करते हैं।

 Object[] portfolio = restTemplate.getForObject(url, Object[].class); 

ध्यान दें कि रेस्ट कंट्रोलरों के लिए (साथ ही स्प्रिंग एमवीसी अनुरोध नियंत्रक के लिए) पथ चर को जर्सी के विपरीत, पथ चर एनोटेशन का उपयोग करके पुनर्प्राप्त किया जाता है, जो कि हमने देखा था, पथ परम का उपयोग करता है।

यह स्प्रिंग रेस्टकंट्रोलर के साथ हमारे मूल्य निर्धारण को समाप्त करता है।

प्रलेखन

हमने इन सभी समस्याओं को हल किया ताकि हम अपने माइक्रोसॉर्क्स का उपयोग कर सकें, लेकिन वे दुनिया को ज्ञान नहीं देंगे कि हम उन्हें कैसे उपयोग करें।

ऐसा करने के लिए, हम सुविधाजनक और आसानी से उपयोग होने वाले स्वैगर टूल का उपयोग करते हैं, जो न केवल हमारे एपीआई कॉल को दस्तावेज करता है, बल्कि उन्हें कॉल करने के लिए एक सुविधाजनक वेब क्लाइंट भी प्रदान करता है।

सबसे पहले, हमारे pom में स्वैगर निर्दिष्ट करें:

 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.7.0</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.7.0</version> </dependency> 

फिर हमें स्वैगर को यह बताने की आवश्यकता है कि हम अपनी कौन सी कक्षाओं में दस्तावेज़ बनाना चाहते हैं। आइए नए SwaggerConfig वर्ग को पेश करते हैं जिसमें Swagger विनिर्देश है।

 @Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket api() { return new Docket(DocumentationType.SWAGGER_2) .select() .apis(RequestHandlerSelectors.any()) .paths(PathSelectors.regex("/pricing.*")) .build(); } } 

देखते हैं कि यह वर्ग क्या करता है। सबसे पहले, हमने इसे @ EnableSwagger2 एनोटेशन के साथ स्वैगर कॉन्फ़िगरेशन के रूप में निर्दिष्ट किया है।

फिर हमने एक Docket घटक बनाया जो Swagger को बताता है कि कौन से API को प्रदर्शित किया जाना चाहिए। उपरोक्त उदाहरण में, हमने स्वैगर को "मूल्य निर्धारण" से शुरू होने वाले किसी भी पथ को प्रदर्शित करने के लिए कहा। एक विकल्प प्रलेखन के लिए कक्षाएं निर्दिष्ट करना होगा, और पथ के लिए नहीं:

 .apis(RequestHandlerSelectors.basePackage("com.restms.demo")) .paths(PathSelectors.any()) 

मूल्य माइक्रोसैस्ट सेवा को पुनः आरंभ करें और http: // localhost: 57216 / swagger-ui.html को ब्राउज़र से कॉल करें



सेवा कार्यों को विस्तार से देखने के लिए सूची संचालन पर क्लिक करें।
प्रपत्र के आधार पर अनुरोध बनाने के लिए ऑपरेशन का विस्तार करें पर क्लिक करें। कुछ पैरामीटर सेट करें, "इसे आज़माएं!" और उत्तर की प्रतीक्षा करें:



आप अपने तरीकों में स्वैगर एनोटेशन जोड़कर बहुत अधिक रंग जोड़ सकते हैं।
उदाहरण के लिए, @ApiOperation एनोटेशन का उपयोग करके मौजूदा PricingImpl.getPricedPortfolio विधि को सजाने के लिए, जैसा कि नीचे दिखाया गया है:

 @ApiOperation(value = "Retrieves a fully priced portfolio", notes = "Retrieves fully priced portfolio given customer id and portfolio id") @GetMapping("/customer/{customer-id}/portfolio/{portfolio-id}") public List<String> getPricedPortfolio(@PathVariable("customer-id") Integer customerId, @PathVariable("portfolio-id") Integer portfolioId) 

नए अद्यतन किए गए दस्तावेज़ देखने के लिए पुनः लोड करें और स्वैगर-यूआई अपडेट करें:



और यह सब आप स्वैगर के साथ नहीं कर सकते हैं, इसलिए दस्तावेज़ीकरण देखें।

हमारे पाठ्यक्रम "स्प्रिंग फ्रेमवर्क पर डेवलपर" के एक व्याख्याता यूरी ड्वोरज़ेत्स्की आपको स्प्रिंग बूट के काम के बारे में और बताएंगे:


मूल लेख