swagger-output.json

{
  "openapi": "3.0.0",
  "info": {
    "title": "EcoFit Rest API",
    "version": "1.0.0",
    "description": "SW 중심대학 통합 해커톤 EcoFit 프로젝트 Rest API Dcoument"
  },
  "servers": [
    {
      "url": "http://localhost:3000"
    }
  ],
  "paths": {
    "/challenge/": {
      "get": {
        "tags": [
          "challenge"
        ],
        "description": "챌린지를 조회하는 기초 API, 테스트용도",
        "parameters": [],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/challenge/click/{title}": {
      "get": {
        "tags": [
          "challenge"
        ],
        "description": "선택된 챌린지의 인증 사진들을 반환하는 API입니다. 매개변수 title을 입력하여, 인증 사진을 받을 수 있습니다.",
        "parameters": [
          {
            "name": "title",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "test"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/challenge/add/{title}": {
      "put": {
        "tags": [
          "challenge"
        ],
        "description": "챌린지 인증을 추가하는 API입니다. 매개변수 title을 입력하여, 챌린지를 참여할 수 있습니다.",
        "parameters": [
          {
            "name": "title",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "test"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/habit/": {
      "get": {
        "tags": [
          "Habit"
        ],
        "description": "습관을 조회하는 기초 API, 테스트용도",
        "parameters": [],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/habit/add/{num}/{newtitle}": {
      "put": {
        "tags": [
          "Habit"
        ],
        "description": "습관을 변경해주는 API입니다. 매개변수 title을 입력하여, 습관을 변경할수 있습니다.",
        "parameters": [
          {
            "name": "num",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "습관을 변경하기 위해 필요한 PK"
          },
          {
            "name": "newtitle",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "습관을 변경하기 위해 필요한 PK"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/habit/click/{title}": {
      "put": {
        "tags": [
          "Habit"
        ],
        "description": "습관을 클릭하면, count를 올려주는 API, 클릭할때마다 1씩 증가",
        "parameters": [
          {
            "name": "title",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "습관을 검색하기 위해 필요한 PK"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/market/": {
      "get": {
        "tags": [
          "Market"
        ],
        "description": "마켓의 상품들을 검색하는 API",
        "parameters": [],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/market/data/image": {
      "get": {
        "tags": [
          "Market"
        ],
        "description": "임시로 그림 불러오는 API",
        "parameters": [],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/market/tag/{tag}": {
      "get": {
        "tags": [
          "Market"
        ],
        "description": "tag별 마켓 상품 검색 API",
        "parameters": [
          {
            "name": "tag",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/market/add": {
      "post": {
        "tags": [
          "Market"
        ],
        "description": "마켓의 상품을 추가하기 위한 API",
        "parameters": [
          {
            "name": "name",
            "description": "상품 검색을 위해 필요한 PK",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "price",
            "description": "가격",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "explanation",
            "description": "상품설명",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "hashTag",
            "description": "hashTag",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "image",
            "description": "imge파일",
            "in": "query",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/user/point": {
      "get": {
        "tags": [
          "User"
        ],
        "description": "사용자 이름과 포인트 조회",
        "parameters": [],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/user/list": {
      "get": {
        "tags": [
          "User"
        ],
        "description": "사용자 참여 챌린지 조회",
        "parameters": [],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }
  }
}