FootPrint이미지 추출과 인바디 결과지 OCR을 위한 RESTful API입니다.
Swagger-UI가 적용되어 있습니다.
sequenceDiagram
participant C as Client
participant S as Server
participant F as Foot
participant S3 as S3
participant SQ as Sql
participant O as OCR
C->>S: PUT /image {id, data}
activate S
S->>F: generate_image(params, './') 이미지, 몸무게 변환요청
activate F
F-->>S: Return Image, Weight values
deactivate F
S->>S3: ImageUploadToS3(id)
activate S3
S3-->>S: Return image_url
deactivate S3
S->>SQ: save(id, image_url, weight) 이미지 URL, 몸무게 저장
activate SQ
SQ-->>S: Save and return confirmation DB저장
deactivate SQ
S-->>C: Return image_url
C->>S: PUT /ocr {image file}
activate S
S->>O: google_ocr(file) 구글 VisionOCR 사용
activate O
O-->>S: Return processed data
deactivate O
S->>SQ: create_health_info(data) OCR 데이터 저장
activate SQ
SQ-->>S: Save and return confirmation
deactivate SQ
S-->>C: Return "test"
- URL:
/image
- 메서드: PUT
- 파라미터:
id
(필수, 문자열): 사용자 아이디
- 요청 본문 예시 :
{ "id": "TEST", "data": "foot_data.json" }
- 응답:
200 OK
: 이미지 가공 및 저장 성공400 Bad Request
: 잘못된 요청500 Internal Server Error
: 서버 오류
- URL:
/health
- 메서드: GET
- 파라미터: 없음
- 요청 본문 예시 : 없음
- 응답:
200 OK
: 서버가 올바르게 실행되고 있는지 확인
- URL:
/check
- 메서드: GET
- 파라미터: 없음
- 요청 본문 예시 : 없음
- 응답:
200 OK
: 서버가 올바르게 실행되고 있는지 확인
- URL:
/ocr
- 메서드: PUT
- 파라미터:
file
(필수, 파일): 이미지 파일
- 요청 본문 예시 :
이 API는 이미지 파일을
file
파라미터를 통해 받습니다. 따라서 본문 예시는 제공되지 않습니다. - 응답:
200 OK
: 이미지 OCR 처리 성공400 Bad Request
: 이미지 파일 누락500 Internal Server Error
: 서버 오류
- 저장소를 복제합니다.
- 필요한 종속성을 설치합니다.
- 이를 위해
pip install -r requirements.txt
명령어를 실행하면 됩니다.
- 이를 위해
- 필요한 설정 파일을 구성합니다.
- 예를 들어, 데이터베이스 연결 설정, API 키 등을 설정해야 합니다.
- 애플리케이션을 실행합니다.
- 애플리케이션은
python route.py
명령어로 실행할 수 있습니다.
- 애플리케이션은
기여는 환영합니다! 문제를 발견하거나 새로운 기능을 추가하려면 이슈를 열거나 Pull Request를 제출해주세요.
이 프로젝트는 MIT 라이선스를 따릅니다.