2016-04-20 13 views
6

मैं स्प्रिंग बूट (ग्रेडल) प्रोजेक्ट पर स्वैगर, अनुबंध और काम करने के लिए नया हूं जहां हम अनुबंधों से निपटने के लिए शुरू कर रहे हैं। मैंने grails का उपयोग किया है, प्यार है कि आप डोमेन में फ़ील्ड defs कैसे डाल सकते हैं और यह ढेर के माध्यम से विरासत में मिलता है।swagger 2 spring boot yml फ़ाइल उत्पन्न करता है

एक विशिष्ट प्रश्न और शायद एक पिग्गी समर्थित स्पैनेशन प्रश्न भी।

मैं मानक नियंत्रक कक्षा से वाईएएमएल फ़ाइल का मूल स्टब कैसे उत्पन्न कर सकता हूं?

मैं समझता हूँ कि मैं निर्देशिका controller\src\test\resources

मैं इस परियोजना में अकड़-ui.html और एक बहुत अच्छा इंटरैक्टिव क्रियान्वित किया है में एक [नाम] -v1-0.yml फ़ाइल बनाने के लिए माना जाता रहा हूँ वेब पेज अनुरोध अंत बिंदु और सामान दिखा रहा है। class SwaggerConfig extends WebMvcConfigurerAdapter का उपयोग करना जो यूई जेसन डॉक वेब पेज में इंटरफेस प्रकाशित करने के लिए काम करता है।

मुझे विश्वास है कि समझ यह है कि परीक्षण संसाधन निर्देशिका में yml फ़ाइल "अनुबंध" की एक निश्चित पीढ़ी होगी और यह सुनिश्चित करने के लिए कि कुछ एपीआई हस्ताक्षर और अनुबंध बिंदु परिवर्तित नहीं हुए हैं, कुछ प्रकार के ग्रेडल परीक्षण विधि में उपयोग किया जाता है, इंटरफेस के मूल जूनिट स्टाइल टेस्ट की तरह। (हां/नहीं?)

मैं आलसी हूं कि मैं खुद को सोच रहा हूं, मैं इस बेवकूफ फ़ाइल को हैकिंग क्यों कर रहा हूं? क्या मेरे लिए नियंत्रक/मॉडल विवरण से बहुत आसान एक यम डॉक कंकाल उत्पन्न किया जा सकता है?

पृष्ठ पर उदाहरण के लिए एक YML फ़ाइल लेता है और ui अनुकूल पेज करता है: http://editor.swagger.io/#/

वास्तव में एक अच्छा "uber" नमूना YAML कि पृष्ठ के रिकॉर्ड नहीं है, मैं वास्तव में है कि लिखने के लिए की जरूरत है, मैं पहले से ही कंट्रोलर, जावाडोक, एनोटेटेड, कूल स्टफ के सभी प्रकारों को लिखा गया है जो यमल के कम से कम एक अच्छी शुरुआत वाली स्टब उत्पन्न करने में सक्षम होना चाहिए, (मैं आपको यह हैक करने के लिए आपको grails दोष नहीं देता!) इससे पहले कि स्प्रिंगफ़ॉक्स एनोटेशन डालने से पहले जो अधिक परीक्षण सामग्री करता है और वास्तव में इस परीक्षण अनुबंध आश्वासन को चलाने के लिए शहर जा रहा है।

FYI करें: 'spring-boot-starter-web' 'spring-boot-starter-test' 'springfox-swagger-ui', version: '2.4.0'

उत्तर

6

मुझे मिल गया। बहुत आसान, मैंने इसे कहीं भी क्यों नहीं देखा। :)

कॉपी/ब्राउज़र में संसाधन पथ पेस्ट:

http://localhost:8095/v2/api-docs?group=full-api

द्वारा निर्मित सामग्री के चयन करें और क्लिपबोर्ड में कॉपी।

खुला एक ब्राउज़र में स्वैगर संपादक:

http://editor.swagger.io

चुनें पेस्ट JSON ... फ़ाइल मेनू से।

जेनरेट किए गए स्वैगर JSON सामग्री पेस्ट करें और आयात पर क्लिक करें।

+0

मैं JSON इस का उपयोग करते हुए उत्पन्न करने में सक्षम हूँ।लेकिन मुझे निम्न त्रुटि मिल रही है .. स्वैगर त्रुटि वैध पैरामीटर परिभाषा नहीं है, कोई विचार है कि मैं त्रुटि और चेतावनियों को कैसे ठीक कर सकता हूं? – Jobin

+0

कमाल ...! मैं पहले मैनुअल कर रहा था .... – Shamseer

1

वहाँ चश्मा की एक YAML प्रतिनिधित्व प्रदान करने के लिए एक सुविधा का अनुरोध है: https://github.com/springfox/springfox/issues/651

प्रगति इसके अलावा, यह नहीं अभी तक उपलब्ध

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