swagger.json

{"openapi":"3.0.0","paths":{"/":{"get":{"operationId":"AppController_getHello","parameters":[],"responses":{"200":{"description":""}}}},"/error":{"get":{"operationId":"AppController_error","parameters":[],"responses":{"200":{"description":""}}}},"/users":{"post":{"operationId":"UsersController_createUser","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUserDto"}}}},"responses":{"201":{"description":""}}}},"/users/email-verify":{"post":{"operationId":"UsersController_verifyEmail","parameters":[],"responses":{"201":{"description":""}}}},"/users/login":{"post":{"operationId":"UsersController_login","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserLoginDto"}}}},"responses":{"201":{"description":""}}}},"/users/{id}":{"get":{"operationId":"UsersController_getUserInfo","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}}}},"/codes":{"post":{"operationId":"CodesController_create","summary":"코드 생성","description":"코드를 생성한다.","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCodeDto"}}}},"responses":{"201":{"description":"정상적으로 코드 생성","content":{"application/json":{"schema":{"$ref":"#/components/schemas/"}}}}},"tags":["코드관리 API"]},"get":{"operationId":"CodesController_findAll","summary":"코드 검색","parameters":[],"responses":{"200":{"description":""}},"tags":["코드관리 API"]}},"/codes/{codeKey}":{"get":{"operationId":"CodesController_findOne","summary":"단일 코드 검색","parameters":[{"name":"codeKey","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"tags":["코드관리 API"]},"patch":{"operationId":"CodesController_update","summary":"단일 코드 업데이트","parameters":[{"name":"codeKey","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCodeDto"}}}},"responses":{"200":{"description":""}},"tags":["코드관리 API"]},"delete":{"operationId":"CodesController_remove","summary":"단일 코드 삭제","parameters":[{"name":"codeKey","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"tags":["코드관리 API"]}},"/admin":{"post":{"operationId":"AdminController_create","summary":"관리자 생성","description":"전체관리자가 관리자를 생성한다.","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAdminDto"}}}},"responses":{"201":{"description":""}},"tags":["관리자 관리 API"]},"get":{"operationId":"AdminController_findAll","parameters":[],"responses":{"200":{"description":""}},"tags":["관리자 관리 API"]}},"/admin/{sno}":{"get":{"operationId":"AdminController_findOne","summary":"단일 관리자 정보 가져오기","parameters":[{"name":"sno","required":true,"in":"path","schema":{"type":"number"}}],"responses":{"200":{"description":""}},"tags":["관리자 관리 API"]},"patch":{"operationId":"AdminController_update","parameters":[{"name":"sno","required":true,"in":"path","schema":{"type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAdminDto"}}}},"responses":{"200":{"description":""}},"tags":["관리자 관리 API"]},"delete":{"operationId":"AdminController_remove","summary":"단일 관리자 삭제","parameters":[{"name":"sno","required":true,"in":"path","schema":{"type":"number"}}],"responses":{"200":{"description":""}},"tags":["관리자 관리 API"]}},"/admin/login":{"post":{"operationId":"AdminController_login","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminLoginDto"}}}},"responses":{"201":{"description":""}},"tags":["관리자 관리 API"]}},"/admin/check":{"post":{"operationId":"AdminController_checkAdminExists","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"201":{"description":""}},"tags":["관리자 관리 API"]}}},"info":{"title":"VC Admin API","description":"The VC Admin API description","version":"0.1","contact":{}},"tags":[{"name":"cats","description":""}],"servers":[],"components":{"schemas":{"CreateUserDto":{"type":"object","properties":{}},"UserLoginDto":{"type":"object","properties":{}},"CreateCodeDto":{"type":"object","properties":{"codeKey":{"type":"string","description":"코드 키(e.g. 001)","example":"001"},"parentKey":{"type":"string","description":"부모키(2차 depth 이상일 경우에만 적용)","example":""},"codeValue":{"type":"string","description":"코드 값","example":"첫번째 코드"},"rootFl":{"type":"string","description":"1차 depth인지 여부","enum":["Y","N"],"example":"Y"},"displayFl":{"type":"string","description":"화면 노출 여부","enum":["Y","N"],"example":"Y"}},"required":["codeKey","codeValue","rootFl","displayFl"]},"UpdateCodeDto":{"type":"object","properties":{}},"CreateAdminDto":{"type":"object","properties":{}},"UpdateAdminDto":{"type":"object","properties":{}},"AdminLoginDto":{"type":"object","properties":{}}}}}