openApi.json

{
    "openapi": "3.0.0",
    "info": { "version": "2.0.1", "title": "My API" },
    "components": {
        "schemas": {
            "Todo": {
                "type": "object",
                "properties": {
                    "id": { "type": "string", "example": "123" },
                    "text": { "type": "string", "example": "Clean my room" },
                    "isDone": { "type": "boolean", "example": false }
                },
                "required": ["id", "text", "isDone"]
            }
        },
        "parameters": {}
    },
    "paths": {
        "/todo/{id}": {
            "put": {
                "parameters": [
                    {
                        "schema": { "type": "string", "minLength": 1, "example": "1212121" },
                        "required": true,
                        "name": "id",
                        "in": "path"
                    }
                ],
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "text": {
                                        "type": "string",
                                        "minLength": 1,
                                        "example": "Clean my room"
                                    },
                                    "isDone": { "type": "boolean", "example": false }
                                }
                            }
                        }
                    }
                },
                "responses": { "200": { "description": "Update an existing todo item" } }
            },
            "delete": {
                "parameters": [
                    {
                        "schema": { "type": "string", "minLength": 1, "example": "1212121" },
                        "required": true,
                        "name": "id",
                        "in": "path"
                    }
                ],
                "responses": { "200": { "description": "Deleted a todo item" } }
            }
        },
        "/todo": {
            "put": {
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "text": {
                                        "type": "string",
                                        "minLength": 1,
                                        "example": "Clean my room"
                                    }
                                },
                                "required": ["text"]
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "Create a new todo item returns the newly created todo item's id",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "id": {
                                            "type": "string",
                                            "description": "The id of the newly created todo item",
                                            "example": "123"
                                        }
                                    },
                                    "required": ["id"]
                                }
                            }
                        }
                    }
                }
            }
        },
        "/todos": {
            "get": {
                "responses": {
                    "200": {
                        "description": "Get all user's todo",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "array",
                                    "items": { "$ref": "#/components/schemas/Todo" }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}