api-blueprint-sample/api.apib at master · txmy/api-blueprint-sample · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
FORMAT: 1A

# Polls

Polls is a simple API allowing consumers to view polls and vote in them.


# Group Get Request Sample

Resources related to questions in the API.

## GET Sample [/getsample]

### List All Questions [GET]
+ Response 200 (application/json)

    + Attributes (array[Question])

### Data Structures

### Question
+ question: Favourite programming language? (required)
+ published_at: `2014-11-11T08:40:51.620Z` (required)
+ url: /questions/1 (required)
+ choices (array[Choice], required)

### Choice
+ choice: Javascript (required)
+ url: /questions/1/choices/1 (required)
+ votes: 2048 (number, required)


# Group Post Request Sample

## POST Sample [/postsample]
### Create a New Question [POST]
サンプルテキスト

+ Request (application/json)

    + Attributes

        + question: Favourite Language? (required)
        + choices: Swift, `Objective-C` (array, required)

+ Response 200 (application/json)

  + Attributes

        + result: hoge (string) - hogeです〜
        + code: 0 (number) - ufga