Api-blueprint: डेटा संरचनाओं का विस्तार

को निर्मित 12 नव॰ 2015 · 6टिप्पणियाँ · स्रोत: apiaryio/api-blueprint

नमस्ते, मेरे पास डेटा संरचनाओं के बारे में एक प्रश्न/प्रस्ताव है। शायद यह अधिक एमएसओएन से संबंधित है लेकिन मैं यहां से शुरू करूंगा। डेटा संरचनाओं को अच्छा और साफ रखने के लिए, मुझे जितना संभव हो उतना कम डुप्लिकेट डेटा चाहिए, इसलिए यह अच्छा होगा यदि डेटा संरचनाएं एक-दूसरे का विस्तार कर सकें।

निम्नलिखित डेटा संरचना मान लें:

# Data Structures

## Project_Link (object) 
+ self: `https://test.api.com/projects/5` (string, required)

## Project1_Get (object)
+ type: `projects` (string, required)
+ id: `5` (string, required)
+ attributes (object, required)
    + number: `PRO-5` (string) - A readable identifier for employees to refer to projects.
+ links (Project_Link, required)

links विशेषता में Project1_Get मैं Project_Link ऑब्जेक्ट का पुन: उपयोग करता हूं जो बहुत अच्छा काम करता है। लेकिन मान लीजिए कि मुझे निम्नलिखित डेटास्ट्रक्चर की भी आवश्यकता है:

## Project1_Identifier (object)
+ type: `projects` (string, required)
+ id: `5` (string, required)

अब मेरे डेटा संरचनाओं में डुप्लिकेट डेटा है क्योंकि Project1_Identifier में type और id विशेषता शामिल है, लेकिन इसमें Project1_Get शामिल है। यह बहुत अच्छा होगा अगर मैं निम्नलिखित कर सकता हूं:

# Data Structures

## Project1_Link (object) 
+ self: `https://test.api.com/projects/5` (string, required)

## Project1_Identifier (object)
+ type: `projects` (string, required)
+ id: `5` (string, required)

## Project1_Get (Project_Identifier) <--- Extend!
+ attributes (object, required)
    + number: `PRO-5` (string) - A readable identifier for employees to refer to projects.
+ links (Project1_Link, required)

निम्नलिखित उदाहरण में ड्राफ्टर त्रुटियाँ लौटाता है:

FORMAT: 1A
HOST: https://test.api.com/

# Test API
Hi, welcome to the API!

# Group Projects
Wow, we are using projects!

### Retrieve single project [GET /projects/{id}]
+ Parameters
    + id: `5` (string, required)

+ Response 200 (application/json)
    + Attributes (object)
        + data (Project1_Get, required)

# Data Structures

## Project_Link (object) 
+ self: `https://test.api.com/projects/5` (string, required)

## Project_Identifier (object)
+ type: `projects` (string, required)
+ id: `5` (string, required)

## Project1_Get (Project_Identifier)
+ type: `projects` (string, required)
+ id: `5` (string, required)
+ attributes (object, required)
    + number: `PRO-5` (string) - A readable identifier for employees to refer to projects.
+ links (Project_Link, required)

user<strong i="25">@development</strong>:/srv/www/docs$ drafter -v
v2.0.0-pre.1
user<strong i="26">@development</strong>:/srv/www/docs$ drafter --validate docs.md --use-line-num

error: (4)  base type 'Project1_Get' is not defined in the document; line 16, column 11 - line 16, column 40
warning: (8)  unable to find the symbol `Project1_Get` in the list of named types; line 16, column 11 - line 16, column 40

Language Parser Implementation Bug

स्रोत

robbinjanssen

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

@robbinjanssen यदि आप उन्हें शीर्ष पर रखना चाहते हैं, तो कृपया ऐसा कुछ करें:

## Project1Get
+ Include ProjectIdentifier
+ attributes (object, required)
    + number: `PRO-5` (string) - A readable identifier for employees to refer to projects.
+ links (ProjectLink, required)

pksunkara 12 नव॰ 2015

👍4 ❤2

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

यह संभव होना चाहिए। ऐसा लगता है कि समस्या प्रकार के नाम में _ है। Project1_Get का नाम बदलकर X करना काम करने लगा।

नोट _ प्रति एमएसओएन स्पेक आरक्षित वर्ण है - https://github.com/apiaryio/mson/blob/master/MSON%20Specification.md#6 -reserved-characters--keywords देखें

हालाँकि मेरा मानना है कि हमारे कार्यान्वयन cc @pksunkara . में यहाँ एक बग है

zdne 12 नव॰ 2015

आप सही हैं, ड्राफ्टर अब निम्नलिखित उदाहरण का उपयोग करके मार्कडाउन को मंजूरी देता है:

FORMAT: 1A
HOST: https://test.api.com/

# Test API
Hi, welcome to the API!

# Group Projects
Wow, we are using projects!

### Retrieve single project [GET /projects/{id}]
+ Parameters
    + id: `5` (string, required)

+ Response 200 (application/json)
    + Attributes (object)
        + data (Project1Get, required)

# Data Structures

## ProjectLink (object) 
+ self: `https://test.api.com/projects/5` (string, required)

## ProjectIdentifier (object)
+ type: `projects` (string, required)
+ id: `5` (string, required)

## Project1Get (ProjectIdentifier)
+ attributes (object, required)
    + number: `PRO-5` (string) - A readable identifier for employees to refer to projects.
+ links (ProjectLink, required)

लेकिन वास्तव में मुझे लगता है कि यह एक बग है, एग्लियो और एपीरीयो इंटरफ़ेस दोनों इसे गलत तरीके से प्रस्तुत कर रहे हैं:

screen shot 2015-11-12 at 11 14 41

संपादित करें: ओह, मुझे लगता है कि apiaryio इसे सही प्रस्तुत कर रहा है! लेकिन यह इस मामले में टाइप/आईडी को नीचे रखता है। मेरी प्राथमिकता इसे सबसे ऊपर रखना होगा।

मैं फिर से अपने दस्तावेज़ों को दोबारा करने से पहले प्रतीक्षा करूंगा ;-)

robbinjanssen 12 नव॰ 2015

@robbinjanssen यदि आप उन्हें शीर्ष पर रखना चाहते हैं, तो कृपया ऐसा कुछ करें:

## Project1Get
+ Include ProjectIdentifier
+ attributes (object, required)
    + number: `PRO-5` (string) - A readable identifier for employees to refer to projects.
+ links (ProjectLink, required)

pksunkara 12 नव॰ 2015

👍4 ❤2

@pksunkara कूल धन्यवाद!

robbinjanssen 12 नव॰ 2015

बग का एक सरल उदाहरण इस प्रकार है:

# GET /projects

+ Response 200 (application/json)
    + Attributes (object)
        + data (B_B, required)

# Data Structures

## A_A
+ a: a

## B_B (A_A)
+ b: b

pksunkara 12 नव॰ 2015

@zdne मुझे लगता है कि यह https://github.com/apiaryio/snowcrash/issues/335 से संबंधित है

pksunkara 12 नव॰ 2015

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

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

Api-blueprint: डेटा संरचनाओं का विस्तार

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

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

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