Api-blueprint: ์†์„ฑ ์ด๋ฆ„์˜ ๋ฐ‘์ค„

์— ๋งŒ๋“  2015๋…„ 07์›” 07์ผ  ยท  4์ฝ”๋ฉ˜ํŠธ  ยท  ์ถœ์ฒ˜: apiaryio/api-blueprint

Attribute ์ด๋ฆ„๊ณผ ์˜ˆ์ œ ๊ฐ’์— ๋ฐ‘์ค„์ด ๋ชจ๋‘ ์žˆ๋Š” ๊ฒฝ์šฐ ํŒŒ์„œ๋Š” ์ „์ฒด ํ–‰์„ null ๊ฐ’์ด ์žˆ๋Š” ์†์„ฑ ์ด๋ฆ„์œผ๋กœ ์ฒ˜๋ฆฌํ•ฉ๋‹ˆ๋‹ค.

์˜ˆ๋ฅผ ๋“ค์–ด ์ด ์ฒญ์‚ฌ์ง„:

# GET /message
+ Response 200 (text/plain)
        + Attributes
            + some_thing: an_example_thing

Drafter์—์„œ ๊ตฌ๋ฌธ ๋ถ„์„ํ•˜๋ฉด ๋‹ค์Œ๊ณผ ๊ฐ™์€ ๊ฒฐ๊ณผ๊ฐ€ ๋‚˜ํƒ€๋‚ฉ๋‹ˆ๋‹ค.

_version: "3.0"
metadata: []
name: ""
description: ""
element: "category"
resourceGroups:
  -
    name: ""
    description: ""
    resources:
      -
        element: "resource"
        name: ""
        description: ""
        uriTemplate: "/message"
        model: {}
        parameters: []
        actions:
          -
            name: ""
            description: ""
            method: "GET"
            parameters: []
            attributes:
              relation: ""
              uriTemplate: ""
            content: []
            examples:
              -
                name: ""
                description: ""
                requests: []
                responses:
                  -
                    name: "200"
                    description: ""
                    headers:
                      -
                        name: "Content-Type"
                        value: "text/plain"
                    body: ""
                    schema: ""
                    content:
                      -
                        element: "dataStructure"
                        name: null
                        typeDefinition:
                          typeSpecification:
                            name: null
                            nestedTypes: []
                          attributes: []
                        sections:
                          -
                            class: "memberType"
                            content:
                              -
                                content:
                                  name:
                                    literal: "some_thing: an_example_thing"
                                  description: ""
                                  valueDefinition:
                                    values: []
                                    typeDefinition:
                                      typeSpecification:
                                        name: null
                                        nestedTypes: []
                                      attributes: []
                                  sections: []
                                class: "property"
        content: []
content:
  -
    element: "category"
    content:
      -
        element: "resource"
        name: ""
        description: ""
        uriTemplate: "/message"
        model: {}
        parameters: []
        actions:
          -
            name: ""
            description: ""
            method: "GET"
            parameters: []
            attributes:
              relation: ""
              uriTemplate: ""
            content: []
            examples:
              -
                name: ""
                description: ""
                requests: []
                responses:
                  -
                    name: "200"
                    description: ""
                    headers:
                      -
                        name: "Content-Type"
                        value: "text/plain"
                    body: ""
                    schema: ""
                    content:
                      -
                        element: "dataStructure"
                        name: null
                        typeDefinition:
                          typeSpecification:
                            name: null
                            nestedTypes: []
                          attributes: []
                        sections:
                          -
                            class: "memberType"
                            content:
                              -
                                content:
                                  name:
                                    literal: "some_thing: an_example_thing"
                                  description: ""
                                  valueDefinition:
                                    values: []
                                    typeDefinition:
                                      typeSpecification:
                                        name: null
                                        nestedTypes: []
                                      attributes: []
                                  sections: []
                                class: "property"
        content: []

์œ ์‚ฌํ•˜๊ฒŒ, ์ด๊ฒƒ์€ Apiary์— ์˜ํ•ด ์ž˜๋ชป ๊ตฌ๋ฌธ ๋ถ„์„๋˜์—ˆ์œผ๋ฉฐ ๊ตฌ๋ฌธ์ด ์ž˜๋ชป ๊ฐ•์กฐ ํ‘œ์‹œ๋ฉ๋‹ˆ๋‹ค.

Question

๊ฐ€์žฅ ์œ ์šฉํ•œ ๋Œ“๊ธ€

Hey MSON ์‚ฌ์–‘์„ ๋ณด๋ฉด _๊ฐ€ ์˜ˆ์•ฝ ๋ฌธ์ž์ž„์„ ์•Œ ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ์ „์ฒด ๋‹จ์–ด๋ฅผ ์ด์Šค์ผ€์ดํ”„ํ•˜๋ ค๋ฉด ์—ญ๋”ฐ์˜ดํ‘œ๋ฅผ ์‚ฌ์šฉํ•˜์‹ญ์‹œ์˜ค. ๋‹ค์Œ์€ ์˜ˆ์ž…๋‹ˆ๋‹ค.

+ `some_thing`: `an_example_thing`

#210์—์„œ UX ๊ฐœ์„ ์ด ๊ณ„ํš๋˜์–ด ์žˆ์Šต๋‹ˆ๋‹ค.

๋ชจ๋“  4 ๋Œ“๊ธ€

Hey MSON ์‚ฌ์–‘์„ ๋ณด๋ฉด _๊ฐ€ ์˜ˆ์•ฝ ๋ฌธ์ž์ž„์„ ์•Œ ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ์ „์ฒด ๋‹จ์–ด๋ฅผ ์ด์Šค์ผ€์ดํ”„ํ•˜๋ ค๋ฉด ์—ญ๋”ฐ์˜ดํ‘œ๋ฅผ ์‚ฌ์šฉํ•˜์‹ญ์‹œ์˜ค. ๋‹ค์Œ์€ ์˜ˆ์ž…๋‹ˆ๋‹ค.

+ `some_thing`: `an_example_thing`

#210์—์„œ UX ๊ฐœ์„ ์ด ๊ณ„ํš๋˜์–ด ์žˆ์Šต๋‹ˆ๋‹ค.

์—ฌ๋Ÿฌ๋ถ„, ์šฐ๋ฆฌ๋Š” ์ด๊ฒƒ์„ ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค:

+ Parameters
     + `grant_type`: `refresh_token` (string, required) - Tipo de concessรฃo

์ž˜ ์ž‘๋™ํ•ฉ๋‹ˆ๋‹ค!

์ •๋ง ์•„๋‹Œ ๊ฒƒ ๊ฐ™์Šต๋‹ˆ๋‹ค. ๋งค๊ฐœ๋ณ€์ˆ˜์™€ ๊ฐ’ ๋ชจ๋‘์— ๋ฐ‘์ค„์ด ์žˆ์œผ๋ฉด JSON์ด ์ž˜๋ชป ๋ Œ๋”๋ง๋˜๋Š” ๊ฒƒ์ž…๋‹ˆ๋‹ค. ์ฒ˜๋Ÿผ

+ aaa_bbb: `ccc_ddd` (string, required) - Example

์˜ˆ, ์ด ๊ฒฝ์šฐ aaa_bbb ๋ฅผ ` ๋กœ ๋‘˜๋Ÿฌ์‹ธ์•ผ ํ•ฉ๋‹ˆ๋‹ค.

์ด ํŽ˜์ด์ง€๊ฐ€ ๋„์›€์ด ๋˜์—ˆ๋‚˜์š”?
0 / 5 - 0 ๋“ฑ๊ธ‰