2016-06-18 9 views
9

में आराम से सेवाओं के लिए दस्तावेज़ों को व्यवस्थित तरीके से कैसे व्यवस्थित करें मैं माइक्रोस्कोर्सेस को व्यवस्थित तरीके से कैसे सेट अप कर रहा हूं और मैं हाल ही में कुछ और अवधारणाओं के साथ लटका रहा हूं, एचएएल, एएलपीएस, और एचएएल ब्राउज़र। मैंने ऐतिहासिक रूप से स्वैगर यूआई का लाभ उठाने वाली चीजें दस्तावेज की हैं, हालांकि, मुझे यह समझने के लिए आ रहा है कि यूआरएल केंद्रित उचित तरीका नहीं है और मुझे संसाधनों और लिंक के आसपास दस्तावेज़ीकरण का आयोजन करना चाहिए जो नई प्रौद्योगिकियों के लिए है। मेरे पास इन नई अवधारणाओं के आस-पास कुछ ज्ञान अंतर हैं, इसलिए मैं इन तकनीकों को एक साथ कैसे काम करता हूं, इसकी उचित समझ लेना चाहता था, क्योंकि मैं प्रत्येक के बारे में सीखता हूं, मैं उन्हें पहेली में फिट कर सकता हूं।माइक्रो-सर्विस आर्किटेक्चर (एचएएल, एएलपीएस)

मेरे वर्तमान समझ है:

एचएएल - JSON के शीर्ष आप लिंक के माध्यम से अपने एपीआई के माध्यम से नेविगेट करने देगा कि पर एक अतिरिक्त प्रारूप है।

आल्प्स - संसाधन के लिए स्वैगर यूआई प्रतिस्थापन और केंद्रित प्रलेखन लिंक - यह JSON के शीर्ष पर एक अतिरिक्त प्रारूप मुझे अंग्रेजी आधारित विवरण प्रदान करने में मदद मेरी संसाधनों

एचएएल ब्राउज़र वर्णन करने के लिए दे सकते हैं कि है। एचएएल और एएलपीएस दोनों के साथ मिलकर काम करता है?

क्या इन तकनीकों की मेरी वर्तमान समझ कुछ क्षेत्रों में सटीक या कमी होगी? इसके अलावा कार्यान्वयन के अनुसार मैं पूरी तरह समझ नहीं पा रहा हूं कि एएलपीएस और एचएएल एक साथ कैसे बातचीत कर रहे हैं। मुझे एक हॉल + जेसन प्रारूप और एक आल्प्स + जेसन प्रारूप के बारे में पता था, लेकिन मैंने एक हॉल + आल्प्स + जेसन प्रारूप नहीं देखा है।

अंतिम क्षेत्र जिसे मैं साफ़ करना चाहता हूं यह है कि मुझे इन संसाधनों को कैसे उजागर करना चाहिए। आम तौर पर मैं हमेशा बहुत दुबला जेसन संदेश पर ध्यान केंद्रित करता हूं, उम्मीद के आस-पास हॉल + जेसन प्रारूप भेज रहा है या क्या मुझे उन एंडपॉइंट्स को अन्य यूआरएल पर विशेष रूप से स्वैगर/एचएएल ब्राउज़र के समान दस्तावेज के लिए होस्ट करना चाहिए?

+0

@ ओलिवरगियरके क्या आप इससे मदद कर पाएंगे? –

उत्तर

3

बडी! इसकी जानकारी का नरक आप यहां समझने की कोशिश कर रहे हैं। मुझे चरणों में व्याख्या करने की कोशिश करें।

प्रलेखन केंद्र का अर्थ सेवाओं और हां के बीच संक्रमण का अर्थ है, इसे वेब पर अर्थात् साझा करने की जानकारी (या डेटा प्रकारों के रूप में समझने) के रूप में जाना जाना चाहिए।

कदम: 1 प्रोटोकॉल (http) डेटा प्रकार मेटाडाटा और मानक डेटा प्रकार के साथ सेवाओं के लिए इस्तेमाल में नीचे दिखाया गया हाइपरमीडिया यानी HTML, XML, JSON, एचएएल आदि उदाहरण JSON के लिए के किसी भी रूप है, जो हो सकता है लिंक के साथ एक मूल दस्तावेज़। दोनों 'todos' और 'प्रोफ़ाइल' केवल हाइपरमीडिया लिंक हैं जो एचएएल आधारित हैं और एचएएल केवल आपके वर्तमान एपीआई को बढ़ाता है।

{ "_links" : { 
    "todos" : { 
     "href" : "http://localhost:8080/todos" 
    }, 
    "profile" : { 
     "href" : "http://localhost:8080/alps" 
    } 
    } 
} 

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

चरण: 2 आल्प्स आवेदन स्तर affordances जो ऊपर JSON में मतलब मुझे पता है क्या तोदो है, लेकिन यह कैसे के साथ बातचीत कर रहे हैं? टोडो के साथ बातचीत करने के लिए, आवेदन स्तर राज्य संक्रमण की आवश्यकता है। 'todo' JSON के नीचे विचार करें जो लिंक से नेविगेट किया गया है और विस्तृत वर्णन जैसे 'वर्णनकर्ता' और 'प्रकार' (सेमेन्टिक, सुरक्षित, यूएनएसएएफई, आदि) दिखाता है।

'आईडी' गुण प्रतिनिधित्व पहचानकर्ता बन जाते हैं। ये स्वतंत्र ALPS राज्य और संक्रमण लागू करने के लिए सेट या नियम हैं।

{ "version" : "1.0", 
    "descriptors" : [ { 
    "id" : "todo-representation", 
    "descriptors" : [ { 
     "name" : "description", 
     "doc" : { 
     "value" : "Details about the TODO item", 
     "format" : "TEXT" 
     }, 
     "type" : "SEMANTIC" 
    }, { 
     "name" : "title", 
     "doc" : { 
     "value" : "Title for the TODO item", 
     "format" : "TEXT" 
     }, 
     "type" : "SEMANTIC" 
    }, { 
     "name" : "id", 
     "type" : "SEMANTIC" 
    } ] 
    }, { 
    "id" : "get-todos", 
    "name" : "todos", 
    "type" : "SAFE", 
    "rt" : "#todo-representation" 
    }, { 
    "id" : "create-todos", 
    "name" : "todos", 
    "type" : "UNSAFE", 
    "rt" : "#todo-representation" 
    }, { 
    "id" : "delete-todo", 
    "name" : "todo", 
    "type" : "IDEMPOTENT", 
    "rt" : "#todo-representation" 
    }, { 
    "id" : "patch-todo", 
    "name" : "todo", 
    "type" : "UNSAFE", 
    "rt" : "#todo-representation" 
    }, { 
    "id" : "get-todo", 
    "name" : "todo", 
    "type" : "SAFE", 
    "rt" : "#todo-representation" 
    } ] 
} 

कुछ लिंक विस्तार slides about ALPS और Rest Example में जांच करने के लिए लायक हैं। उम्मीद है कि इससे आपको समझने में मदद मिलेगी।

+0

आपके उत्तर के लिए बहुत बहुत धन्यवाद! इस स्पष्टीकरण ने एक गुच्छा की मदद की! –

+0

खुशी, यह वास्तव में आपके लिए काम किया =) – AHashmi

0

मैंने प्रत्येक माइक्रो सेवाओं में स्वयं को एपीआई दस्तावेज यूआरएल swagger है। पूर्व: http://myservice1domain:8080/swagger-ui.html। मैंने ALPS का उपयोग नहीं किया है। इसके अलावा, मुझे नहीं लगता कि आपको विशेष रूप से केवल एचएएल प्रकार की सामग्री का पर्दाफाश करना पड़ सकता है क्योंकि वे प्रतिक्रिया डेटा से बंधे हैं। वैसे भी एचएएल नमूना अनुरोध निकाय के रूप में swagger में उपयोगकर्ता के सामने खुलासा और प्रतिक्रिया जेसन सही

+0

मेरी समझ से एचएएल संसाधनों को दस्तावेज करने के लिए संसाधनों को दस्तावेज करने के लिए संसाधनों को दस्तावेज करने के लिए है। चूंकि यह संसाधन है जो हमें सबसे ज्यादा रूचि है, मैं पढ़ रहा हूं कि एचएएल दस्तावेज एक बेहतर दृष्टिकोण है। –

संबंधित मुद्दे