swagger.json

{
  "openapi": "3.0.0",
  "info": {
    "version": "1.0.0",
    "title": "Rest Swagger",
    "description": "🚀🌳 Build a Rest API using Swagger.",
    "contact": {
      "email": "cuongw.me@gmail.com"
    }
  },
  "paths": {
    "/api/cats": {
      "get": {
        "summary": "Returns a list of cats.",
        "description": "Get all the cats.",
        "responses": {
          "200": {
            "description": "A JSON array of cats",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": [{
                    "type": "object",
                    "properties": {
                      "name": "string",
                      "color": "string"
                    }
                  }],
                  "example": [
                    {
                      "_id": "5ce21e41f528e61ddc8b87ea",
                      "name": "dog",
                      "color": "white",
                      "__v": 0
                    },
                    {
                      "_id": "5ce21ea4f528e61ddc8b87eb",
                      "name": "spider",
                      "color": "black",
                      "__v": 0
                    }
                  ]
                }
              }
            }
          }
        }
      },
      "post": {
        "summary": "Create a cat.",
        "description": "Create a cat.",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string"
                  },
                  "color": {
                    "type": "string"
                  }
                },
                "required": [
                  "name",
                  "color"
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "A JSON string",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": "string"
                  },
                  "example": {
                    "message": "Cat created!"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/cats/{catId}": {
      "get": {
        "summary": "Returns a cat by id",
        "description": "Get a single cat.",
        "parameters": [
          {
            "name": "catId",
						"in": "path",
						"required": true,
						"description": "The id of the cat",
						"schema": {
							"type": "string"
						}
          }
        ],
        "responses": {
          "200": {
            "description": "A JSON object of cat",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "name": "string",
                    "color": "string"
                  },
                  "example": {
                    "_id": "5ce21e41f528e61ddc8b87ea",
                    "name": "dog",
                    "color": "white",
                    "__v": 0
                  }
                }
              }
            }
          }
        }
      },
      "put": {
        "summary": "Update a cat by id.",
        "description": "Update a cat by id.",
        "parameters": [
          {
            "name": "catId",
						"in": "path",
						"required": true,
						"description": "The id of the cat",
						"schema": {
							"type": "string"
						}
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string"
                  },
                  "color": {
                    "type": "string"
                  }
                },
                "required": [
                  "name",
                  "color"
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "A JSON string",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": "string"
                  },
                  "example": {
                    "message": "Cat updated!"
                  }
                }
              }
            }
          }
        }
      },
      "delete": {
        "summary": "Delete a cat by id.",
        "description": "Delete a cat by id.",
        "parameters": [
          {
            "name": "catId",
						"in": "path",
						"required": true,
						"description": "The id of the cat",
						"schema": {
							"type": "string"
						}
          }
        ],
        "responses": {
          "200": {
            "description": "A JSON string",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": "string"
                  },
                  "example": {
                    "message": "Cat deleted!"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}