SunTzuAPI/swagger.json at master · OneByteGH/SunTzuAPI · 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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
{
  "swagger": "2.0",
  "info": {
    "version": "1.0.0",
    "title": "Sun Tzu Quotes API"
  },
  "paths": {
    "/quote": {
      "get": {
        "description": "Get a random quote",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "A single quote",
            "examples": {
              "application/json": "{\n                  \"quote\": \"The supreme art of war is to subdue the enemy without losing sight of the battle.\"\n              }"
            },
            "schema": {
              "type": "object",
              "properties": {
                "quote": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    },
    "/quote/{id}": {
      "get": {
        "description": "Get a quote by id",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The quote id",
            "required": true,
            "type": "integer"
          }
        ],
        "responses": {
          "200": {
            "description": "A single quote",
            "examples": {
              "application/json": "{\n                  \"quote\": \"The supreme art of war is to subdue the enemy without losing sight of the battle.\"\n              }"
            },
            "schema": {
              "type": "object",
              "properties": {
                "quote": {
                  "type": "string"
                }
              }
            }
          },
          "404": {
            "description": "Quote not found",
            "examples": {
              "application/json": "{\n                \"error\": \"Quote not found\"\n              }"
            }
          }
        }
      }
    },
    "/quotes": {
      "get": {
        "description": "Get all quotes",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "A list of quotes",
            "examples": {
              "application/json": "[\n  \"QUOTE\",\n \"QUOTE\",\n  \"QUOTE\",.......]"
            },
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}