openapiNodeScafolding/helloWorldOpenAPI.json at main · mpackermancc/openapiNodeScafolding · 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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
{
    "openapi": "3.0.0",
    "info": {
        "version": "v1.0",
        "title": "Hello World",
        "description": "This is an example for generating a Node app scafold from an OpenAPI spec"
    },
    "paths": {
        "/hello": {
            "get": {
                "responses": {
                    "200": {
                        "description": "success response",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/responseGetHello"
                                }
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "firstname",
                        "in": "query",
                        "description": "The first name of the person to say hello to.",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "lastname",
                        "in": "query",
                        "description": "The last name of the person to say hello to.",
                        "required": false,
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "laterDate",
                        "in": "query",
                        "description": "The future date to wait to say hello.",
                        "required": false,
                        "schema": {
                            "type": "string",
                            "format": "date"
                        }
                    }
                ],
                "operationId": "hello_get"
            },
            "post": {
                "responses": {
                    "200": {
                        "description": "success response",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/responseGetHello"
                                }
                            }
                        }
                    }
                },
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/requestPostHello"
                            }
                        }
                    }
                },
                "operationId": "hello_post"
            }
        },
        "/time/{offset}/show": {
            "get": {
                "responses": {
                    "200": {
                        "description": "success response",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/responseGetTime"
                                }
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "offset",
                        "in": "path",
                        "description": "The hours offset from GMT for which you would like time returned",
                        "required": true,
                        "schema": {
                            "type": "integer"
                        }
                    }
                ],
                "operationId": "time_{offset}_show_get"
            }
        }
    },
    "components": {
      "schemas": {
        "responseGetHello": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string"
              },
              "success": {
                "type": "boolean"
              },
              "createdAt": {
                "type": "string",
                "format": "date-time"
              }
            }
        },
        "requestPostHello": {
            "type": "object",
            "properties": {
              "newMessage": {
                "type": "string"
              }
            },
            "required": [
              "newMessage"
            ]
        },
        "responseGetTime": {
            "type": "object",
            "properties":{
                "currentTime": {
                    "type": "string",
                    "format": "date-time"
                }
            }
        }
      }
    }
}