api-docs.json

{
    "components": {
        "schemas": {
            "EntityModelUser": {
                "properties": {
                    "birthDate": {
                        "format": "date-time",
                        "type": "string"
                    },
                    "id": {
                        "format": "int32",
                        "type": "integer"
                    },
                    "links": {
                        "items": {
                            "$ref": "#/components/schemas/Link"
                        },
                        "type": "array"
                    },
                    "name": {
                        "maxLength": 2147483647,
                        "minLength": 2,
                        "type": "string"
                    }
                },
                "type": "object"
            },
            "HelloWorldBean": {
                "properties": {
                    "message": {
                        "type": "string"
                    }
                },
                "type": "object"
            },
            "Link": {
                "properties": {
                    "deprecation": {
                        "type": "string"
                    },
                    "href": {
                        "type": "string"
                    },
                    "hreflang": {
                        "type": "string"
                    },
                    "media": {
                        "type": "string"
                    },
                    "name": {
                        "type": "string"
                    },
                    "profile": {
                        "type": "string"
                    },
                    "rel": {
                        "type": "string"
                    },
                    "title": {
                        "type": "string"
                    },
                    "type": {
                        "type": "string"
                    }
                },
                "type": "object"
            },
            "User": {
                "properties": {
                    "birthDate": {
                        "format": "date-time",
                        "type": "string"
                    },
                    "id": {
                        "format": "int32",
                        "type": "integer"
                    },
                    "name": {
                        "maxLength": 2147483647,
                        "minLength": 2,
                        "type": "string"
                    }
                },
                "type": "object"
            }
        }
    },
    "info": {
        "title": "OpenAPI definition",
        "version": "v0"
    },
    "openapi": "3.0.1",
    "paths": {
        "/hello-world": {
            "get": {
                "operationId": "helloWorld",
                "responses": {
                    "200": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "type": "string"
                                }
                            }
                        },
                        "description": "OK"
                    }
                },
                "tags": [
                    "hello-world-controller"
                ]
            }
        },
        "/hello-world-bean": {
            "get": {
                "operationId": "helloWorldBean",
                "responses": {
                    "200": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "$ref": "#/components/schemas/HelloWorldBean"
                                }
                            }
                        },
                        "description": "OK"
                    }
                },
                "tags": [
                    "hello-world-controller"
                ]
            }
        },
        "/hello-world-get": {
            "get": {
                "operationId": "helloWorldGet",
                "responses": {
                    "200": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "type": "string"
                                }
                            }
                        },
                        "description": "OK"
                    }
                },
                "tags": [
                    "hello-world-controller"
                ]
            }
        },
        "/hello-world-internationalized": {
            "get": {
                "operationId": "helloWorldInternationalized",
                "responses": {
                    "200": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "type": "string"
                                }
                            }
                        },
                        "description": "OK"
                    }
                },
                "tags": [
                    "hello-world-controller"
                ]
            }
        },
        "/hello-world/{name}": {
            "get": {
                "operationId": "helloWorldPathVariable",
                "parameters": [
                    {
                        "in": "path",
                        "name": "name",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "$ref": "#/components/schemas/HelloWorldBean"
                                }
                            }
                        },
                        "description": "OK"
                    }
                },
                "tags": [
                    "hello-world-controller"
                ]
            }
        },
        "/users": {
            "get": {
                "operationId": "getAllUsers",
                "responses": {
                    "200": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "items": {
                                        "$ref": "#/components/schemas/User"
                                    },
                                    "type": "array"
                                }
                            }
                        },
                        "description": "OK"
                    }
                },
                "tags": [
                    "user-resource"
                ]
            },
            "post": {
                "operationId": "createUser",
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/User"
                            }
                        }
                    },
                    "required": true
                },
                "responses": {
                    "200": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "type": "object"
                                }
                            }
                        },
                        "description": "OK"
                    }
                },
                "tags": [
                    "user-resource"
                ]
            }
        },
        "/users/{id}": {
            "delete": {
                "operationId": "deleteUser",
                "parameters": [
                    {
                        "in": "path",
                        "name": "id",
                        "required": true,
                        "schema": {
                            "format": "int32",
                            "type": "integer"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK"
                    }
                },
                "tags": [
                    "user-resource"
                ]
            },
            "get": {
                "operationId": "getOneUser",
                "parameters": [
                    {
                        "in": "path",
                        "name": "id",
                        "required": true,
                        "schema": {
                            "format": "int32",
                            "type": "integer"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "$ref": "#/components/schemas/EntityModelUser"
                                }
                            }
                        },
                        "description": "OK"
                    }
                },
                "tags": [
                    "user-resource"
                ]
            }
        },
        "/users/{id}/posts": {
            "get": {
                "operationId": "getPosts",
                "parameters": [
                    {
                        "in": "path",
                        "name": "id",
                        "required": true,
                        "schema": {
                            "format": "int32",
                            "type": "integer"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "items": {
                                        "type": "string"
                                    },
                                    "type": "array"
                                }
                            }
                        },
                        "description": "OK"
                    }
                },
                "tags": [
                    "user-resource"
                ]
            },
            "post": {
                "operationId": "addPost",
                "parameters": [
                    {
                        "in": "path",
                        "name": "id",
                        "required": true,
                        "schema": {
                            "format": "int32",
                            "type": "integer"
                        }
                    }
                ],
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "string"
                            }
                        }
                    },
                    "required": true
                },
                "responses": {
                    "200": {
                        "description": "OK"
                    }
                },
                "tags": [
                    "user-resource"
                ]
            }
        },
        "/users/{id}/posts/{post_id}": {
            "get": {
                "operationId": "getPost",
                "parameters": [
                    {
                        "in": "path",
                        "name": "id",
                        "required": true,
                        "schema": {
                            "format": "int32",
                            "type": "integer"
                        }
                    },
                    {
                        "in": "path",
                        "name": "postId",
                        "required": true,
                        "schema": {
                            "format": "int32",
                            "type": "integer"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "type": "string"
                                }
                            }
                        },
                        "description": "OK"
                    }
                },
                "tags": [
                    "user-resource"
                ]
            }
        }
    },
    "servers": [
        {
            "description": "Generated server url",
            "url": "http://localhost:8080"
        }
    ]
}