Api-blueprint: JSON-RPC के लिए URI ओवरलोडिंग का समर्थन करें

apiary.io पर जा रहा है।

@rodriguise मुझे इस मुद्दे के बारे में जानकारी कहां मिल सकती है? मेरे पास एक ही विचार है, आरपीसी जैसी एपीआई का समर्थन करने के लिए यह एक अच्छी सुविधा होगी।

@rodriguise मुझे इस कार्यक्षमता में भी बहुत दिलचस्पी है, क्या आप कह सकते हैं कि मैं इस मुद्दे के बारे में कहां से सीख सकता हूं?

@adammbalogh @SvyatoslavVasiliev क्या आप लोग अपने उपयोग के मामले का थोड़ा और वर्णन कर सकते हैं?

@pksunkara यकीन है।
मेरे पास JSON-RPC 2.0 विशिष्टता के अनुसार डिज़ाइन किया गया API है, उदाहरण के लिए:

पोस्ट http://somehost.com/rpc_api

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "entity.get",
  "params": {
    "filter": {
      "filters": [
        {
          "field": "name",
          "operator": "eq",
          "value": "Bob"
        },
        {
          "field": "age",
          "operator": "eq",
          "value": 25
        }
      ],
      "condition": "and"
    }
  }
}

इस तरह के एपीआई में विधियों के समूह के लिए केवल एक यूआरएल है, जहां "विधि" पैरामीटर में विधियों के नाम शरीर में निहित हैं।
पथ-केंद्रित भाषा संरचना के कारण वर्तमान ब्लूप्रिंट प्राप्ति ऐसे एपीआई का वर्णन करने की अनुमति नहीं देती है।

हाय @pksunkara , क्या आपके पास इस बारे में कोई खबर है?
मैंने एपियरी के बजाय अन्य रेंडरिंग टूल्स (उदाहरण के लिए एग्लियो) का उपयोग करने की कोशिश की है, और उन्होंने एपियरी के विपरीत प्रलेखन का सही ढंग से प्रतिनिधित्व किया। लेकिन वे उपकरण कुछ विशेषताओं जैसे विशेषताएँ को अलग अनुभाग के रूप में प्रस्तुत करने का समर्थन नहीं करते हैं।
यदि आप मेरी समस्या का समाधान करने में मदद करते हैं तो यह बहुत अच्छा होगा।

अरे @SvyatoslavVasiliev तो अगर मैं इसे सही ढंग से पढ़ता हूं तो JSON RPC के लिए एक समर्थन https://github.com/apiaryio/api-blueprint/issues/289 के अंतर्गत आ रहा है, तकनीकी रूप से प्रोटोकॉल अभी भी HTTP है।

यूआरआई और एचटीटीपी विधियों से संसाधनों और क्रिया परिभाषाओं को कम करने से इस मामले में भी मदद मिलनी चाहिए।

क्या यह समझ में आता है? अतिरिक्त विवरण के लिए कृपया #289 देखें

हाय @zdne ,
मैंने #289 को समझने की कोशिश की है, लेकिन मैं इसे पूरी तरह समझ नहीं पा रहा हूं।
मेरा एपीआई परिवहन के रूप में JSON बॉडी के साथ HTTP का उपयोग करता है, लेकिन इसमें केवल एक URL है और केवल HTTP POST का उपयोग करता है। शरीर में "विधि" परम में निहित संसाधन और विधि के बारे में सभी जानकारी।
उदाहरण के लिए, इकाई प्राप्त करें:
{ "jsonrpc": "2.0", "id": 1, "method": "entity.get", "params": { "filter": { "filters": [ { "field": "name", "operator": "eq", "value": "Bob" }, { "field": "age", "operator": "eq", "value": 25 } ], "condition": "and" } } }

इकाई हटाएं:
{ "jsonrpc": "2.0", "id": 1, "method": "entity.delete", "params": { "id": "123" } }

दोनों विधियों को HTTP POST कहा जाता है http://myservice.com/rpcapi

अब तक मुझे JSON-RPC API का दस्तावेजीकरण करने का एक आधुनिक और कार्यात्मक तरीका नहीं मिला है (जिसका उपयोग मैं परीक्षण उत्पन्न करने के लिए भी कर सकता हूं)। मेरी आशा एपीआई ब्लूप्रिंट थी लेकिन ऐसा लगता है कि यह वास्तव में समर्थित नहीं है। क्या किसी को इसके एपीआई ब्लूप्रिंट की भविष्य की योजनाओं के बारे में पता है या इसका समर्थन करने वाले एक अलग संरचना/उपकरण के लिए कोई सुझाव है?

@Dynom मैं युगल सलाह दे सकता हूं।
आप एपीआई ब्लूप्रिंट के लिए एग्लियो रेंडर की कोशिश कर सकते हैं, यह विशेषता अनुभाग प्रस्तुत नहीं करता है, लेकिन दस्तावेज़ की संरचना को सही ढंग से प्रदर्शित करता है।
एक अन्य उपकरण एपीआई डॉक है , मैं वर्तमान क्षण में इसका परीक्षण कर रहा हूं और यह उपयुक्त लगता है।

धन्यवाद @SvyatoslavVasiliev मैं इनलाइन दस्तावेज़ीकरण समाधानों का उपयोग नहीं करना चाहता और एपीआई डॉक्टर विज्ञापन करता है कि यह रीस्टफुल सेवाओं के लिए है, इसलिए मुझे यकीन नहीं है कि हम लंबे समय में इससे बहुत उम्मीद कर सकते हैं।