2009-11-13 8 views
10

मुझे एक आरईएसटीफुल एपीआई बनाने के लिए एक आरेख बनाने की आवश्यकता है जो निर्माण करता है, जिसे यूएमएल आरेख का उपयोग करना चाहिए?मॉडल एपीआई के लिए यूएमएल आरेख

अग्रिम धन्यवाद,

+0

@AboutDev क्या कोई मुझे एपीआई के उदाहरण या नमूना मॉडलिंग के लिए एक लिंक प्रदान कर सकता है, जैसे जावा एपीआई अनुक्रम आरेखों का उपयोग कर सकता है? – Debashisenator

उत्तर

11

Sequence diagrams एक अच्छी शुरुआत कर रहे हैं। लेकिन आप यह देखने के लिए अलग-अलग types of diagrams के बारे में पढ़ने से बेहतर हैं कि आपका बॉस/प्रोफेसर आदि क्या चाहता है।

+0

मैं एक संचार आरेख का उपयोग करने में सोच रहा था, लेकिन एक अनुक्रम आरेख भी व्यवहार्य लगता है। धन्यवाद, – Hugo

2

यह निर्भर करता है कि आप क्या व्यक्त करना चाहते हैं, लेकिन जब एपीआई दिखाते हैं तो sequence diagram आरेख पर जाता है।

+0

अपनी टिप्पणी के लिए धन्यवाद =) – Hugo

11

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

एक वर्ग रेखाचित्र एक प्रणाली की संरचना को दर्शाता है। इसलिए, यदि आप अपने एपीआई के विधि/फ़ंक्शन हस्ताक्षर दिखाना चाहते हैं और वे किस तरह से वितरित किए जाते हैं, तो यही वह है जो आपको उपयोग करना चाहिए।

या आप दोनों को अपने एपीआई के विभिन्न विचारों को चित्रित करने के लिए उपयोग कर सकते हैं।

+0

अपनी टिप्पणी के लिए धन्यवाद =) मुझे लगता है कि दोनों के संयोजन विजेता होगा =) – Hugo

+0

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

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