Apicurio-studio: वाईएमएल एपीआई में पथ क्रम का आदेश नहीं दिया गया है और यूआई में पथ से मेल नहीं खाता है

को निर्मित 12 मार्च 2019 · 5टिप्पणियाँ · स्रोत: Apicurio/apicurio-studio

नमस्ते,

मुझे नहीं पता कि यह बग है या एन एन्हांसमेंट, लेकिन यहाँ यह है

मुद्दे का विवरण

मान लें कि मैं चार पथों के साथ एक एपीआई बनाना चाहता हूं:

POST /bar
GET /bar/{id_bar}
POST /foo
GET /foo/{id_foo}

लेकिन आइए मान लें कि मैं उन्हें इस विशिष्ट क्रम में UI का उपयोग करके सम्मिलित करता हूं:

GET /foo/{id_foo}
POST /bar
GET /bar/{id_bar}
POST /foo

यूआई अच्छा है और पथ क्रमबद्ध दिखाई देते हैं, जो मैं चाहता हूं उससे मेल खाता हूं:

लेकिन, परिणामी yml का आदेश नहीं दिया गया है और UI में दिखाई देने वाली चीज़ों से मेल नहीं खाता है:

openapi: 3.0.2
info:
    title: 'Test API'
    version: 1.0.0
paths:
    '/foo/{id_foo}': {}
    /bar: {}
    '/bar/{id_bar}': {}
    /foo: {}

आम तौर पर, मैं वास्तव में कच्चे yml फ़ाइल में पथों के क्रम की परवाह नहीं करता
लेकिन बात यह है कि ReDoc yml . में पथों के क्रम का अनुसरण करता है

तो परिणामी दस्तावेज का आदेश नहीं दिया गया है:

यह एक समस्या है क्योंकि एक बार जब एक एपीआई जीना शुरू कर देता है, तो कुछ पथ अपडेट हो जाते हैं, कुछ हटा दिए जाते हैं और कुछ बन जाते हैं
इसका मतलब है कि परिणामी दस्तावेज़ीकरण जल्दी से एक गड़बड़ गड़बड़ बन रहा है

क्या किया जा सकता है

मेरे पास कुछ विचार हैं, वे परिपूर्ण से बहुत दूर हैं लेकिन यह एक शुरुआत है
शायद हम उन पर निर्माण कर सकते हैं और विस्तृत कर सकते हैं

हमेशा आउटपुट एपीआई को सॉर्ट करें
पेशेवरों: लागू करने में आसान (मुझे लगता है?)
विपक्ष: उपयोगकर्ता अपने स्वयं के आदेश का चयन करने में असमर्थ हैं
आउटपुट एपीआई में पथों को क्रमबद्ध करने के लिए एक विकल्प जोड़ें
पेशेवरों: लागू करने में आसान (मुझे लगता है?)
विपक्ष: उपयोगकर्ता अलग-अलग पथों के क्रम को बदलने में सक्षम नहीं है
UI को संशोधित करें ताकि प्रदर्शित पथों का आदेश न दिया जाए,
और सब कुछ सॉर्ट करने के लिए एक बटन जोड़ें + अलग-अलग रास्तों को ऊपर और नीचे ले जाने के लिए बटन
पेशेवरों: सब कुछ हल कर देंगे
विपक्ष: लागू करने के लिए सबसे कठिन (मुझे लगता है?)

enhancement

स्रोत

Nicnl

👍1

सबसे उपयोगी टिप्पणी

मैं भी इस मुद्दे में भाग गया; इस पर मेरा अवलोकन यह है कि जब हम नए पथ बनाते हैं तो APICURIO वर्तमान YAML में नई परिभाषा जोड़ता है; या जब हम yaml को पूरी तरह से बदल देते हैं (उदाहरण के लिए व्यक्तिगत पथ के लिए यदि मैं 'स्रोत' टैब से कुछ संशोधित करता हूं)।

मैं मैन्युअल रूप से YAML को संशोधित करने के बाद इसे ठीक करने के लिए डेटाबेस में हेरफेर करता हूं (फिर कॉलम को अपडेट करता हूं), और किसी तरह सब कुछ टूट गया कि मुझे प्रोजेक्ट को हटाना होगा और फिर से पुनरारंभ करना होगा।

जैसा कि @EricWittmann ने कहा कि मुझे लगता है कि सामग्री को ReDoc को सौंपने से पहले पथ और अन्य सूचियों को सॉर्ट करना सबसे अच्छा है, या हम 'प्रारूप' बटन के बगल में 'स्रोत' टैब में एक और बटन का उपयोग कर सकते हैं (शायद 'सॉर्ट पथ' के रूप में नामकरण), जिसे हम खुद संभाल सकते हैं।

kesuskim 5 अप्रैल 2019

👍2

सभी 5 टिप्पणियाँ

ओह, क्षमा करें, मैं उस YML को संलग्न करना भूल गया जिसका उपयोग मैंने ReDoc स्क्रीनशॉट के लिए किया था
(जिसे मैंने चिपकाया है उसका संचालन नहीं है, इसलिए ReDoc एक खाली दस्तावेज़ बनाता है)

openapi: 3.0.2
info:
    title: 'Test API'
    version: 1.0.0
paths:
    '/foo/{id_foo}':
        get:
            summary: 'Obtain a foo'
            parameters:
                -
                    name: id_foo
                    in: path
                    required: true
                    schema:
                        type: number
            responses:
                '201':
                    description: 'A foo'
    /bar:
        post:
            summary: 'Create a bar'
            responses:
                '200':
                    description: 'A bar'
    '/bar/{id_bar}':
        get:
            summary: 'Obtain a bar'
            parameters:
                -
                    name: id_bar
                    in: path
                    required: true
                    schema:
                        type: number
            responses:
                '201':
                    description: 'Bar created'
    /foo:
        post:
            summary: 'Create a foo'
            responses:
                '200':
                    description: 'Foo created'

Nicnl 12 मार्च 2019

यह एक दिलचस्प मुद्दा है जो आश्चर्यजनक रूप से पहले नहीं आया है! यूआई में वास्तव में कुछ स्थान हैं जहां मुझे लगता है कि हमें आपका विकल्प सी प्रदान करना चाहिए - आइटम को दस्तावेज़ में दिखाई देने के क्रम में प्रदर्शित करें लेकिन सॉर्ट करने और फिर से ऑर्डर करने के लिए विकल्प प्रदान करें (संभवतः खींचें और छोड़ें)।

उस ने कहा, सामग्री को ReDoc को सौंपने से पहले पथ और अन्य सूचियों को क्रमबद्ध करना एक अस्थायी समाधान होगा। यह तेज़ और करने में आसान होगा और एपिकुरियो "पूर्वावलोकन" सुविधा की विशिष्ट समस्या को ठीक करेगा।

इस पर कोई विचार/विचार, @jsenko ?

EricWittmann 12 मार्च 2019

kesuskim 5 अप्रैल 2019

👍2

# 394 की तरह, मुझे लगता है कि यहां सामान्य विचार यह है कि एपिकुरियो यूआई को सभी प्रकार के तत्वों (पथ, फ़ील्ड, शायद डेटा प्रकार) के लिए वाईएएमएल ऑर्डरिंग के अनुरूप होना चाहिए क्योंकि वह ऑर्डर कभी-कभी महत्वपूर्ण होता है (जैसे दस्तावेज़ीकरण उत्पन्न करने के लिए)।

एक साधारण चीज जो यहां मददगार होगी, वह है कच्चे YAML को संपादित करते समय सेव बटन को सक्षम करना और केवल तत्वों के क्रम को बदलना। वर्तमान में, एपिकुरियो थोड़ा अधिक स्मार्ट है और सेव बटन को धूसर कर देता है जब केवल एक चीज जो बदल गई है वह है तत्वों का क्रम।

BenjaminPelletier 10 जुल॰ 2019

👍1

मुझे लगता है कि यूआई में स्रोत से मेल खाने के लिए सबसे अच्छी बात है (जैसा कि बताया गया है) और उपयोगकर्ताओं के लिए ड्रैग एंड ड्रॉप के माध्यम से सामान को स्थानांतरित करने में सक्षम होना। यह कोई मामूली बदलाव नहीं है लेकिन आईएमओ करना सही बात है। विचार @jsenko ?

EricWittmann 11 जुल॰ 2019

क्या यह पृष्ठ उपयोगी था?

0 / 5 - 0 रेटिंग्स

Apicurio-studio: वाईएमएल एपीआई में पथ क्रम का आदेश नहीं दिया गया है और यूआई में पथ से मेल नहीं खाता है

मुद्दे का विवरण

क्या किया जा सकता है

सबसे उपयोगी टिप्पणी

सभी 5 टिप्पणियाँ

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