ipify/api/openapi.json at main · go-api-libs/ipify · 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
{
  "openapi": "3.1.0",
  "info": {
    "title": "ipify API",
    "description": "A simple public IP address API, easy to integrate into any application in seconds.",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://api.ipify.org"
    },
    {
      "url": "https://api64.ipify.org"
    }
  ],
  "paths": {
    "/": {
      "parameters": [
        {
          "$ref": "#/components/parameters/format"
        }
      ],
      "get": {
        "summary": "Get you public IP address",
        "operationId": "GetIP",
        "responses": {
          "200": {
            "$ref": "#/components/responses/IPResponse"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "IPWrapper": {
        "type": "object",
        "properties": {
          "ip": {
            "type": "string",
            "format": "ipv4",
            "example": "89.39.107.192"
          }
        },
        "required": [
          "ip"
        ],
        "example": {
          "ip": "89.39.107.192"
        }
      }
    },
    "responses": {
      "IPResponse": {
        "description": "Returns the IP address of the requester.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/IPWrapper"
            },
            "example": {
              "ip": "89.39.107.192"
            }
          }
        }
      }
    },
    "parameters": {
      "format": {
        "name": "format",
        "in": "query",
        "schema": {
          "type": "string",
          "example": "json"
        },
        "example": "json"
      }
    }
  },
  "externalDocs": {
    "description": "API documentation",
    "url": "https://www.ipify.org/"
  }
}