Skip to content

Commit

Permalink
[#28] docs: 자세 분석 보고서 관련 API 문서 최신화
Browse files Browse the repository at this point in the history
  • Loading branch information
@YehyeokBang
YehyeokBang committed Jan 23, 2024
1 parent dcaf79a commit 0af5d01
Show file tree
Hide file tree
Showing 3 changed files with 375 additions and 116 deletions.
180 changes: 139 additions & 41 deletions docs/docs.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,50 +15,64 @@ const docTemplate = `{
"host": "{{.Host}}",
"basePath": "{{.BasePath}}",
"paths": {
"/health": {
"/analysis": {
"get": {
"description": "서버가 정상 작동 중인지 확인합니다.",
"security": [
{
"Bearer": []
}
],
"description": "로그인한 사용자의 자세 추정 결과를 조회합니다.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"HealthCheck"
"Reports"
],
"summary": "서버 상태 확인",
"summary": "자세 추정 결과 조회",
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/global.Response"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/global.Response"
}
}
}
}
},
"/login": {
},
"post": {
"description": "토큰을 반환합니다. (첫 로그인 시 회원가입이 진행 후 토큰을 반환합니다.)",
"security": [
{
"Bearer": []
}
],
"description": "자세를 추정합니다. (동영상 URL을 입력받아 자세를 추정합니다.)",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Users"
"Reports"
],
"summary": "로그인 (첫 로그인 시 회원가입)",
"summary": "자세 추정 요청",
"parameters": [
{
"description": "사용자 정보",
"name": "user",
"description": "동영상 URL",
"name": "video_url",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/types.RequestCreateUser"
"$ref": "#/definitions/types.RequestAnalysis"
}
}
],
Expand All @@ -78,14 +92,14 @@ const docTemplate = `{
}
}
},
"/predict": {
"/analysis/all": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "로그인한 사용자의 자세 추정 결과를 조회합니다.",
"description": "자세 추정 결과를 조회합니다.",
"consumes": [
"application/json"
],
Expand All @@ -95,7 +109,7 @@ const docTemplate = `{
"tags": [
"Reports"
],
"summary": "자세 추정 결과 조회",
"summary": "자세 추정 결과 전체 조회 (테스트용)",
"responses": {
"200": {
"description": "OK",
Expand All @@ -110,14 +124,16 @@ const docTemplate = `{
}
}
}
},
"post": {
}
},
"/analysis/summary": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "자세를 추정합니다. (동영상 URL을 입력받아 자세를 추정합니다.)",
"description": "로그인한 사용자의 자세 추정 결과를 월별로 요약하여 조회합니다.",
"consumes": [
"application/json"
],
Expand All @@ -127,16 +143,14 @@ const docTemplate = `{
"tags": [
"Reports"
],
"summary": "자세 추정 요청",
"summary": "자세 추정 결과 월별 요약 조회",
"parameters": [
{
"description": "동영상 URL",
"name": "video_url",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/types.RequestPredict"
}
"type": "string",
"description": "조회할 년월 (YYYYMM)",
"name": "ym",
"in": "query",
"required": true
}
],
"responses": {
Expand All @@ -155,14 +169,14 @@ const docTemplate = `{
}
}
},
"/predict/all": {
"/analysis/{id}": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "자세 추정 결과를 조회합니다.",
"description": "보고서 id로 자세 추정 결과를 조회합니다.",
"consumes": [
"application/json"
],
Expand All @@ -172,7 +186,79 @@ const docTemplate = `{
"tags": [
"Reports"
],
"summary": "자세 추정 결과 전체 조회 (테스트용)",
"summary": "자세 추정 결과 id로 조회",
"parameters": [
{
"type": "integer",
"description": "자세 추정 결과 id",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/global.Response"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/global.Response"
}
}
}
}
},
"/health": {
"get": {
"description": "서버가 정상 작동 중인지 확인합니다.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"HealthCheck"
],
"summary": "서버 상태 확인",
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/global.Response"
}
}
}
}
},
"/login": {
"post": {
"description": "토큰을 반환합니다. (첫 로그인 시 회원가입이 진행 후 토큰을 반환합니다.)",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Users"
],
"summary": "로그인 (첫 로그인 시 회원가입)",
"parameters": [
{
"description": "사용자 정보",
"name": "user",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/types.RequestCreateUser"
}
}
],
"responses": {
"200": {
"description": "OK",
Expand Down Expand Up @@ -367,34 +453,46 @@ const docTemplate = `{
}
}
},
"types.RequestCreateUser": {
"types.RequestAnalysis": {
"type": "object",
"required": [
"email",
"name"
"alert_count",
"analysis_time",
"type",
"video_url"
],
"properties": {
"age": {
"alert_count": {
"type": "integer"
},
"email": {
"type": "string"
"analysis_time": {
"type": "integer"
},
"gender": {
"type": {
"type": "string"
},
"name": {
"video_url": {
"type": "string"
}
}
},
"types.RequestPredict": {
"types.RequestCreateUser": {
"type": "object",
"required": [
"video_url"
"email",
"name"
],
"properties": {
"video_url": {
"age": {
"type": "integer"
},
"email": {
"type": "string"
},
"gender": {
"type": "string"
},
"name": {
"type": "string"
}
}
Expand Down
Loading

0 comments on commit 0af5d01

Please sign in to comment.