nodejs-base-project/swagger.json at main · tecnodeveloper/nodejs-base-project · 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.0.0",
  "info": {
    "title": "My Api",
    "version": "1.0.0"
  },
  "paths": {
    "/": {
      "get": {
        "summary": "Welcome dashboard",
        "description": "Welcome message of dashboard to check api working",
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string",
                  "example": "Welcome to Api"
                }
              }
            }
          }
        }
      }
    },
    "/api/book": {
      "post": {
        "summary": "Creating Book in database",
        "description": "When you hit this route you need to give json input body of data that you want to store on database ",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": ["bookName", "author", "price", "publisher"],
                "properties": {
                  "bookName": {
                    "type": "string",
                    "example": "Atomic Habbits"
                  },
                  "author": {
                    "type": "array",
                    "'items": { "type": "string" },
                    "example": ["james clear"]
                  },
                  "price": {
                    "type": "number",
                    "example": "100"
                  },
                  "publisher": {
                    "type": "string",
                    "example": "Hamdard publisher"
                  }
                }
              }
            }
          }
        }
      }
    },
    "responses": {
      "201": {
        "description": "Book Created succesfully",
        "content": {
          "application/json": {
            "example": {
              "messaage": "Book created succesfully",
              "data": {
                "id": 1,
                "bookName": "Atomic Habbit",
                "price": 100,
                "author": [
                  "name" : "james clear",
                ]
              }
            }
          }
        }
      }
    }
  }
}