UberFactsAPI/swagger.json at main · OneByteGH/UberFactsAPI · 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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
{
    "swagger": "2.0",
    "info": {
      "version": "1.0.0",
      "title": "UberFacts API"
    },
    "paths": {
      "/fact": {
        "get": {
          "description": "Get a random fact",
          "produces": [
            "application/json"
          ],
          "responses": {
            "200": {
              "description": "A single fact",
              "examples": {
                "application/json": "{\n                  \"id\":0,\n\"fact\": \"This API is cool.\"\n              }"
              },
              "schema": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "integer"
                  },
                  "fact": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      },
      "/fact/{id}": {
        "get": {
          "description": "Get a fact by id",
          "produces": [
            "application/json"
          ],
          "parameters": [
            {
              "name": "id",
              "in": "path",
              "description": "The fact id",
              "required": true,
              "type": "integer"
            }
          ],
          "responses": {
            "200": {
              "description": "A single fact",
              "examples": {
                "application/json": "{\n                  \"id\":0,\n\"fact\": \"This API is cool.\"\n              }"
              },
              "schema": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "integer"
                  },
                  "fact": {
                    "type": "string"
                  }
                }
              }
            },
            "404": {
              "description": "Fact not found",
              "examples": {
                "application/json": "{\n                \"error\": \"Fact not found\"\n              }"
              }
            }
          }
        }
      },
      "/facts": {
        "get": {
          "description": "Get all facts",
          "produces": [
            "application/json"
          ],
          "responses": {
            "200": {
              "description": "A list of facts",
              "examples": {
                "application/json": "[\r\n    {\r\n        \"id\": 0,\r\n        \"fact\": \"dingus\"\r\n    },\r\n    {\r\n        \"id\": 1,\r\n        \"fact\": \"dingus\"\r\n...    }\r\n]"
              },
              "schema": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "integer"
                    },
                    "fact": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }