2016-06-29 9 views
7

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

एकमात्र चीज जिसे मैंने अब तक पाया है https://github.com/bayeslife/api-add-in, ईए के लिए आरएएमएल उत्पन्न करने के लिए एक प्लगइन और अधिक था। क्या किसी के पास बेहतर दृष्टिकोण है? postmanerator

मैं:

+0

आपको सैंडर हुगेंडुर्न से संपर्क करना चाहिए। एंटरप्राइज़ आर्किटेक्ट में उनके आरईएसटी एपीआई सहित माइक्रोस्कोर्सेस मॉडलिंग के लिए उनके पास एक दृष्टिकोण है। –

+0

आमतौर पर (अच्छी तरह से, हमेशा) मैं प्रलेखन बनाने के लिए एपीआई तरीका जाता हूं। तो उपर्युक्त तब तक सबसे अच्छा दृष्टिकोण प्रतीत होता है जब तक कि आप सबकुछ स्वयं नहीं करना चाहते हैं। –

+0

@ थॉमसकिलियन, "एपीआई रास्ता" से आपका क्या मतलब है? –

उत्तर

0

मैं तुम्हें postmanerator सेवा है जो एपीआई के लिए प्रलेखन उत्पन्न का उपयोग स्वचालित रूप से सिर्फ एक संग्रह में डाकिया में API कॉल बचाने के लिए और आप लिंक postmanerator के लिए यह प्रलेखन उत्पन्न करता है इस सेवा को यह कलेक्टर पारित करने के लिए सलाह देते हैं उम्मीद है कि मेरा जवाब उपयोगी होगा

+0

धन्यवाद, लेकिन पोस्टमनेटर उपकरण एंटरप्राइज़ आर्किटेक्ट का उपयोग करने का समाधान नहीं है। –

3

सैंडर हुगेंडुर्न द्वारा प्रस्तुति 'मॉडलिंग माइक्रोस्कोर्सेस' में एंटरप्राइज़ आर्किटेक्ट में एक आरईएसटी एपीआई मॉडलिंग के बारे में कुछ रोचक स्लाइड शामिल हैं। प्रस्तुति slideshare.net पर उपलब्ध है। सबसे दिलचस्प स्लाइड स्लाइड # 75 है। यहाँ चित्र उस स्लाइड पर दिखाया गया है:

Class model of REST service

(क्लास और विशेषता नाम डच में हैं Verklaring का मतलब घोषणा और Verklaringen का मतलब घोषणाएं लेकिन इस उदाहरण के पीछे व्यापार प्रासंगिक नहीं है।।।)

यह अच्छा होगा अगर एंटरप्राइज़ आर्किटेक्ट के लिए इन क्लास आरेखों को स्वैगर चश्मा (ओपन एपीआई चश्मे) में परिवर्तित करने के लिए प्लगइन होगा।

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