Generating OpenAPI specifications using GPT-3#

I wanted to start playing around with OpenAPI. I decided to see if I could get GPT-3 to generate the first version of a specification for me.

I used this prompt:

1
Write an OpenAPI JSON specification for the following APIs:
2

3
GET /data/docs.json
4

5
Returns:
6

7
{
8
  "database": "data",
9
  "table": "docs",
10
  "rows": [
11
    {
12
      "id": 1,
13
      "title": "A title"
14
    },
15
    {
16
      "id": 2,
17
      "title": "Another doc"
18
    }
19
  ]
20
}
21

22
POST /data/-/create
23
{
24
  "table": "my_new_table",
25
  "columns": [
26
    {
27
      "name": "id",
28
      "type": "integer"
29
    },
30
    {
31
      "name": "age",
32
      "type": "float"
33
    },
34
    {
35
      "name": "title",
36
      "type": "text"
37
    }
38
  ],
39
  "pk": "id"
40
}
41

42
Output:
43

44
{
45
  "ok": true,
46
  "database": "data",
47
  "table": "my_new_table",
48
  "table_url": "http://127.0.0.1:8001/data/my_new_table"
49
}

I had to hit the button in the Playground a few times due to the length, but the eventual output looked like this:

1
{
2
  "swagger": "2.0",
3
  "info": {
4
    "version": "1.0.0",
5
    "title": "Data API"
6
  },
7
  "paths": {
8
    "/data/docs.json": {
9
      "get": {
10
        "tags": [
11
          "data"
12
        ],
13
        "summary": "Get data from docs.json",
14
        "operationId": "getData",
15
        "produces": [
16
          "application/json"
17
        ],
18
        "parameters": [],
19
        "responses": {
20
          "200": {
21
            "description": "Successful response",
22
            "schema": {
23
              "type": "object",
24
              "properties": {
25
                "database": {
26
                  "type": "string"
27
                },
28
                "table": {
29
                  "type": "string"
30
                },
31
                "rows": {
32
                  "type": "array",
33
                  "items": {
34
                    "type": "object",
35
                    "properties": {
36
                      "id": {
37
                        "type": "integer"
38
                      },
39
                      "title": {
40
                        "type": "string"
41
                      }
42
                    }
43
                  }
44
                }
45
              }
46
            }
47
          }
48
        }
49
      }
50
    },
51
    "/data/{id}": {
52
      "post": {
53
        "tags": [
54
          "data"
55
        ],
56
        "summary": "Create a new table",
57
        "operationId": "createTable",
58
        "produces": [
59
          "application/json"
60
        ],
61
        "parameters": [
62
          {
63
            "name": "table",
64
            "in": "path",
65
            "required": true,
66
            "type": "string"
67
          },
68
          {
69
            "name": "columns",
70
            "in": "body",
71
            "required": true,
72
            "schema": {
73
              "type": "array",
74
              "items": {
75
                "type": "object",
76
                "properties": {
77
                  "name": {
78
                    "type": "string"
79
                  },
80
                  "type": {
81
                    "type": "string"
82
                  }
83
                }
84
              }
85
            }
86
          },
87
          {
88
            "name": "pk",
89
            "in": "body",
90
            "required": true,
91
            "type": "string"
92
          }
93
        ],
94
        "responses": {
95
          "200": {
96
            "description": "Successful response",
97
            "schema": {
98
              "type": "object",
99
              "properties": {
100
                "ok": {
101
                  "type": "boolean"
102
                },
103
                "database": {
104
                  "type": "string"
105
                },
106
                "table": {
107
                  "type": "string"
108
                },
109
                "table_url": {
110
                  "type": "string"
111
                }
112
              }
113
            }
114
          }
115
        }
116
      }
117
    }
118
  }
119
}