Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update api docs 2024-08-11 12:27:44 #20

Open
wwan13 opened this issue Aug 11, 2024 · 0 comments
Open

update api docs 2024-08-11 12:27:44 #20

wwan13 opened this issue Aug 11, 2024 · 0 comments

Comments

@wwan13
Copy link
Contributor

wwan13 commented Aug 11, 2024

{
"openapi": "3.0.1",
"info": {
"title": "API documentation",
"version": "1.0.0"
},
"servers": [
{
"url": "http://localhost"
}
],
"tags": [],
"paths": {
"/api/v1/cartridge": {
"post": {
"tags": [
"cartridge"
],
"summary": "카드리지 (약) 등록 API",
"operationId": "append-cartridge",
"requestBody": {
"content": {
"application/json;charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/api-v1-cartridge1468055381"
},
"examples": {
"append-cartridge": {
"value": "{"number":1,"memo":"memo","dosage":5.0,"doesPerDay":3,"totalDoseDays":7,"drugRemains":30,"repeatable":true,"reminderTerm":48,"dispenserId":"MGE2NGZ","drugId":3,"reminderSoundId":1}"
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/api-v1-cartridge-schedule916321208"
},
"examples": {
"append-cartridge": {
"value": "{"status":"SUCCESS","data":{"id":1},"timestamp":"2024-08-11 21:27:38"}"
}
}
}
}
}
}
}
},
"/api/v1/drug": {
"get": {
"tags": [
"drug"
],
"summary": "약 이름 자동완성 API",
"operationId": "search-drug-by-name",
"parameters": [
{
"name": "name",
"in": "query",
"description": "약 이름",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/api-v1-drug2071534301"
},
"examples": {
"search-drug-by-name": {
"value": "{"status":"SUCCESS","data":{"id":1,"name":"가스디알정50밀리그램(디메크로틴산마그네슘)","identifier":200808876,"produce":"일동제약(주)","description":"녹색의 원형 필름코팅정","classification":"기타의 소화기관용약","division":"전문의약품","longLength":7.6,"shortLength":7.6,"thick":3.6,"imageUrl":"https://nedrug.mfds.go.kr/pbp/cmn/itemImageDownload/147426403087300104\"},\"timestamp\":\"2024-08-11 21:27:39"}"
}
}
}
}
}
}
}
},
"/api/v1/patient": {
"post": {
"tags": [
"patient"
],
"summary": "환자 등록 API",
"operationId": "append-patient",
"requestBody": {
"content": {
"application/json;charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/api-v1-patient-patientId-272837857"
},
"examples": {
"append-patient": {
"value": "{"name":"김태완","birth":"2001-02-22","diseaseName":"알츠하이머","since":"2019-03-02","severity":2}"
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/api-v1-patient-637801896"
},
"examples": {
"append-patient": {
"value": "{"status":"SUCCESS","data":{"id":1},"timestamp":"2024-08-11 21:27:41"}"
}
}
}
}
}
}
}
},
"/api/v1/sound": {
"get": {
"tags": [
"reminder-sound"
],
"summary": "알림음 목록 API",
"description": "유저 회원가입시 기본 알림음이 자동으로 생성됩니다.",
"operationId": "all-reminder-sounds",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "인증토큰",
"required": true,
"schema": {
"type": "string"
},
"example": "Bearer {bearer token}"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/api-v1-sound-1671860611"
},
"examples": {
"all-reminder-sounds": {
"value": "{"status":"SUCCESS","data":{"count":2,"sounds":[{"id":1,"name":"기본 알림음","url":"url"},{"id":2,"name":"커스텀 알림음","url":"url"}]},"timestamp":"2024-08-11 21:27:43"}"
}
}
}
}
}
}
}
},
"/api/v1/user": {
"get": {
"tags": [
"user"
],
"summary": "유저 정보 조회 API",
"operationId": "read-user",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "인증토큰",
"required": true,
"schema": {
"type": "string"
},
"example": "Bearer {bearer token}"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/api-v1-user-1258169084"
},
"examples": {
"read-user": {
"value": "{"status":"SUCCESS","data":{"name":"김태완","profileImage":"profileImage"},"timestamp":"2024-08-11 21:27:43"}"
}
}
}
}
}
}
}
},
"/api/v1/cartridge/schedule": {
"post": {
"tags": [
"cartridge"
],
"summary": "카드리지(약), 알림 동시 등록 API",
"operationId": "append-cartridge-reminder-schedule",
"requestBody": {
"content": {
"application/json;charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/api-v1-cartridge-schedule-2116590121"
},
"examples": {
"append-cartridge-reminder-schedule": {
"value": "{"number":1,"memo":"memo","dosage":5.0,"doesPerDay":3,"totalDoseDays":7,"drugRemains":30,"repeatable":true,"dispenserId":"MGE2NGZ","drugId":3,"reminderSoundId":1,"schedules":[{"dayOfWeek":"MON","time":"12:00:00"},{"dayOfWeek":"MON","time":"18:00:00"},{"dayOfWeek":"WED","time":"12:00:00"},{"dayOfWeek":"WED","time":"18:00:00"}]}"
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/api-v1-cartridge-schedule916321208"
},
"examples": {
"append-cartridge-reminder-schedule": {
"value": "{"status":"SUCCESS","data":{"id":1},"timestamp":"2024-08-11 21:27:37"}"
}
}
}
}
}
}
}
},
"/api/v1/cartridge/{cartridgeId}": {
"delete": {
"tags": [
"cartridge"
],
"summary": "카트리지 삭제 API",
"operationId": "remove-cartridges",
"parameters": [
{
"name": "cartridgeId",
"in": "path",
"description": "삭제하려는 카트리지 Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/api-v1-cartridge-cartridgeId-1776866862"
},
"examples": {
"remove-cartridges": {
"value": "{"status":"SUCCESS","data":null,"timestamp":"2024-08-11 21:27:37"}"
}
}
}
}
}
}
}
},
"/api/v1/dispenser/id": {
"get": {
"tags": [
"dispenser"
],
"summary": "디스펜서 아이디 생성 API",
"description": "이 API로 id 생성 후 디스펜서 등록 API를 실행해 주세요",
"operationId": "generate-dispenser-id",
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/api-v1-dispenser-dispenserId-1846498768"
},
"examples": {
"generate-dispenser-id": {
"value": "{"status":"SUCCESS","data":{"id":"MGE2NGZ"},"timestamp":"2024-08-11 21:27:39"}"
}
}
}
}
}
}
}
},
"/api/v1/dispenser/{dispenserId}": {
"post": {
"tags": [
"dispenser"
],
"summary": "디스펜서 등록 API",
"description": "입력한 dispenserId로 id가 설정됩니다.",
"operationId": "register-dispenser",
"parameters": [
{
"name": "dispenserId",
"in": "path",
"description": "등록하려는 디스펜서 ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Authorization",
"in": "header",
"description": "인증토큰",
"required": true,
"schema": {
"type": "string"
},
"example": "Bearer {bearer token}"
}
],
"requestBody": {
"content": {
"application/json;charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/api-v1-dispenser-dispenserId-1160846675"
},
"examples": {
"register-dispenser": {
"value": "{"patientId":1}"
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/api-v1-dispenser-dispenserId-1846498768"
},
"examples": {
"register-dispenser": {
"value": "{"status":"SUCCESS","data":{"id":"MGE2NGZ"},"timestamp":"2024-08-11 21:27:38"}"
}
}
}
}
}
}
}
},
"/api/v1/drug/all": {
"get": {
"tags": [
"drug"
],
"summary": "약 목록 API",
"operationId": "all-drug",
"parameters": [
{
"name": "size",
"in": "query",
"description": "검색 크기",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "검색 페이지",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/api-v1-drug-all646786864"
},
"examples": {
"all-drug": {
"value": "{"status":"SUCCESS","data":{"count":2,"drugs":[{"id":1,"name":"가스디알정50밀리그램(디메크로틴산마그네슘)","identifier":200808876,"produce":"일동제약(주)","description":"어두운 황색의 원형 필름코팅정","classification":"항악성종양제","division":"전문의약품","longLength":7.6,"shortLength":7.6,"thick":3.6,"imageUrl":"https://nedrug.mfds.go.kr/pbp/cmn/itemImageDownload/147426403087300104"},{"id":2,"name":"페라트라정2.5밀리그램(레트로졸)","identifier":200808877,"produce":"(주)유한양행","description":"녹색의 원형 필름코팅정","classification":"기타의 소화기관용약","division":"전문의약품","longLength":6.1,"shortLength":6.1,"thick":3.5,"imageUrl":"https://nedrug.mfds.go.kr/pbp/cmn/itemImageDownload/147426403087300107"}]},"timestamp":"2024-08-11 21:27:39"}"
}
}
}
}
}
}
}
},
"/api/v1/drug/autocomplete": {
"get": {
"tags": [
"drug"
],
"summary": "약 이름 자동완성 API",
"operationId": "auto-complete-drug-name",
"parameters": [
{
"name": "keyword",
"in": "query",
"description": "약 이름 키워드",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/api-v1-drug-autocomplete-1131437847"
},
"examples": {
"auto-complete-drug-name": {
"value": "{"status":"SUCCESS","data":{"count":3,"names":["프레가스타캡슐150밀리그램(프레가발린)","프레가스타캡슐300밀리그램(프레가발린)","프레가스타캡슐75밀리그램(프레가발린)"]},"timestamp":"2024-08-11 21:27:39"}"
}
}
}
}
}
}
}
},
"/api/v1/patient/{patientId}": {
"get": {
"tags": [
"patient"
],
"summary": "환자 조회 API",
"operationId": "read-patient",
"parameters": [
{
"name": "patientId",
"in": "path",
"description": "조회하려는 환자 ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json;charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/api-v1-patient-dispenser-dispenserId486549215"
},
"examples": {
"read-patient": {
"value": "{"name":"김태완","birth":"2001-02-22","diseaseName":"알츠하이머","since":"2019-03-02","severity":2}"
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/api-v1-patient-dispenser-dispenserId-350463104"
},
"examples": {
"read-patient": {
"value": "{"status":"SUCCESS","data":{"id":1,"name":"김태완","birth":"2001-02-22","diseaseName":"알츠하이머","since":"2019-03-02","severity":2},"timestamp":"2024-08-11 21:27:41"}"
}
}
}
}
}
}
},
"patch": {
"tags": [
"patient"
],
"summary": "환자 수정 API",
"operationId": "modify-patient",
"parameters": [
{
"name": "patientId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json;charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/api-v1-patient-patientId-272837857"
},
"examples": {
"modify-patient": {
"value": "{"name":"김태완","birth":"2001-02-22","diseaseName":"알츠하이머","since":"2019-03-02","severity":2}"
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/api-v1-patient-patientId370834879"
},
"examples": {
"modify-patient": {
"value": "{"status":"SUCCESS","data":{"id":1},"timestamp":"2024-08-11 21:27:41"}"
}
}
}
}
}
}
}
},
"/api/v1/user/name": {
"get": {
"tags": [
"user"
],
"summary": "유저 이름 조회 API",
"operationId": "read-user-name",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "인증토큰",
"required": true,
"schema": {
"type": "string"
},
"example": "Bearer {bearer token}"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/api-v1-user-name-1490293479"
},
"examples": {
"read-user-name": {
"value": "{"status":"SUCCESS","data":{"name":"김태완"},"timestamp":"2024-08-11 21:27:43"}"
}
}
}
}
}
}
}
},
"/api/v1/auth/kakao/refresh": {
"post": {
"tags": [
"auth"
],
"summary": "refresh token",
"operationId": "refresh-token-API",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer refreshToken",
"required": true,
"schema": {
"type": "string"
},
"example": "Bearer {bearer token}"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/api-v1-auth-kakao-refresh829476423"
},
"examples": {
"refresh-token-API": {
"value": "{"status":"SUCCESS","data":{"accessToken":"accessToken","refreshToken":"refreshToken?"},"timestamp":"2024-08-11 21:27:35"}"
}
}
}
}
}
}
}
},
"/api/v1/cartridge/using/{dispenserId}": {
"get": {
"tags": [
"cartridge"
],
"summary": "사용중인 카트리지 조회 API",
"operationId": "using-cartridges",
"parameters": [
{
"name": "dispenserId",
"in": "path",
"description": "조회하려는 디스펜서 Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/api-v1-cartridge-using-dispenserId1293555252"
},
"examples": {
"using-cartridges": {
"value": "{"status":"SUCCESS","data":{"usingNumbers":[1,3,4]},"timestamp":"2024-08-11 21:27:38"}"
}
}
}
}
}
}
}
},
"/api/v1/cartridge/{cartridgeId}/reminder": {
"post": {
"tags": [
"reminder"
],
"summary": "알람 등록 API",
"operationId": "append-reminders",
"parameters": [
{
"name": "cartridgeId",
"in": "path",
"description": "알람을 등록하려는 카트리지 ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json;charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/api-v1-cartridge-cartridgeId-reminder-1638760233"
},
"examples": {
"append-reminders": {
"value": "{"schedules":[{"dayOfWeek":"MON","time":"12:00:00"},{"dayOfWeek":"MON","time":"18:00:00"},{"dayOfWeek":"WED","time":"12:00:00"},{"dayOfWeek":"WED","time":"18:00:00"}]}"
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/api-v1-cartridge-cartridgeId-reminder-1719529968"
},
"examples": {
"append-reminders": {
"value": "{"status":"SUCCESS","data":{"id":1},"timestamp":"2024-08-11 21:27:42"}"
}
}
}
}
}
}
},
"delete": {
"tags": [
"reminder"
],
"summary": "모든 알람 삭제 API",
"operationId": "remove-reminders",
"parameters": [
{
"name": "cartridgeId",
"in": "path",
"description": "알람을 제거하려는 카트리지 ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/api-v1-cartridge-cartridgeId-reminder-800630051"
},
"examples": {
"remove-reminders": {
"value": "{"status":"SUCCESS","data":{"id":1},"timestamp":"2024-08-11 21:27:42"}"
}
}
}
}
}
}
},
"patch": {
"tags": [
"reminder"
],
"summary": "알람 재설정 API",
"operationId": "replace-reminders",
"parameters": [
{
"name": "cartridgeId",
"in": "path",
"description": "알람을 재설정하려는 카트리지 ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json;charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/api-v1-cartridge-cartridgeId-reminder-1638760233"
},
"examples": {
"replace-reminders": {
"value": "{"schedules":[{"dayOfWeek":"TUE","time":"12:00:00"},{"dayOfWeek":"FRI","time":"18:00:00"}]}"
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/api-v1-cartridge-cartridgeId-reminder-1719529968"
},
"examples": {
"replace-reminders": {
"value": "{"status":"SUCCESS","data":{"id":1},"timestamp":"2024-08-11 21:27:42"}"
}
}
}
}
}
}
}
},
"/api/v1/drug/all/keyword": {
"get": {
"tags": [
"drug"
],
"summary": "키워드 기반 약 목록 API",
"operationId": "all-drug-by-keyword",
"parameters": [
{
"name": "keyword",
"in": "query",
"description": "검색 키워드",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/api-v1-drug-all646786864"
},
"examples": {
"all-drug-by-keyword": {
"value": "{"status":"SUCCESS","data":{"count":2,"drugs":[{"id":1,"name":"가스디알정50밀리그램(디메크로틴산마그네슘)","identifier":200808876,"produce":"일동제약(주)","description":"어두운 황색의 원형 필름코팅정","classification":"항악성종양제","division":"전문의약품","longLength":7.6,"shortLength":7.6,"thick":3.6,"imageUrl":"https://nedrug.mfds.go.kr/pbp/cmn/itemImageDownload/147426403087300104"},{"id":4,"name":"가스프렌정(모사프리드시트르산염이수화물)","identifier":200809076,"produce":"경동제약(주)","description":"분할선을 가진 흰색의 장방형 필름코팅정제","classification":"기타의 소화기관용약","division":"전문의약품","longLength":9.1,"shortLength":4.5,"thick":3.4,"imageUrl":"https://nedrug.mfds.go.kr/pbp/cmn/itemImageDownload/147426403087300143"}]},"timestamp":"2024-08-11 21:27:40"}"
}
}
}
}
}
}
}
},
"/api/v1/drug/check/{dispenserId}": {
"post": {
"tags": [
"drug-check"
],
"summary": "약 혼용 확인 API (ai)",
"operationId": "drug-combinable-check",
"parameters": [
{
"name": "dispenserId",
"in": "path",
"description": "추가하려는 디스펜서 ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json;charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/api-v1-drug-check-dispenserId-633689209"
},
"examples": {
"drug-combinable-check": {
"value": "{"drugNames":["코큐렉스연질캡슐","제일아노민정","덴티콤캡슐"]}"
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/api-v1-drug-check-dispenserId-1700343202"
},
"examples": {
"drug-combinable-check": {
"value": "{"status":"SUCCESS","data":{"isCombinable":true,"caution":"주의사항"},"timestamp":"2024-08-11 21:27:40"}"
}
}
}
}
}
}
}
},
"/api/v1/patient/dispenser/{dispenserId}": {
"get": {
"tags": [
"patient"
],
"summary": "디스펜서 ID 기반 환자 조회 API",
"operationId": "read-patient-by-dispenser-id",
"parameters": [
{
"name": "dispenserId",
"in": "path",
"description": "조회하려는 디스펜서 ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json;charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/api-v1-patient-dispenser-dispenserId486549215"
},
"examples": {
"read-patient-by-dispenser-id": {
"value": "{"name":"김태완","birth":"2001-02-22","diseaseName":"알츠하이머","since":"2019-03-02","severity":2}"
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/api-v1-patient-dispenser-dispenserId-350463104"
},
"examples": {
"read-patient-by-dispenser-id": {
"value": "{"status":"SUCCESS","data":{"id":1,"name":"김태완","birth":"2001-02-22","diseaseName":"알츠하이머","since":"2019-03-02","severity":2},"timestamp":"2024-08-11 21:27:41"}"
}
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"api-v1-dispenser-dispenserId-1846498768": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "디스펜서 ID"
}
}
},
"timestamp": {
"type": "string",
"description": "응답 시간"
},
"status": {
"type": "string",
"description": "응답 상태"
}
}
},
"api-v1-cartridge-schedule-2116590121": {
"type": "object",
"properties": {
"totalDoseDays": {
"type": "number",
"description": "총 투약 일수"
},
"dosage": {
"type": "number",
"description": "투여량"
},
"number": {
"type": "number",
"description": "카트리지 번호"
},
"reminderSoundId": {
"type": "number",
"description": "알람 사운드 ID"
},
"dispenserId": {
"type": "string",
"description": "디스펜서 ID"
},
"repeatable": {
"type": "boolean",
"description": "반복알림 여부"
},
"schedules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"dayOfWeek": {
"type": "string",
"description": "요일 (MON, TUE, WED, THU, FRI, SAT, SUN)"
},
"time": {
"type": "string",
"description": "시간 (HH:mm:ss)"
}
}
}
},
"drugRemains": {
"type": "number",
"description": "남은 알약 갯수"
},
"memo": {
"type": "string",
"description": "메모"
},
"drugId": {
"type": "number",
"description": "약 ID"
},
"doesPerDay": {
"type": "number",
"description": "1일 투여 횟수"
}
}
},
"api-v1-patient-patientId-272837857": {
"type": "object",
"properties": {
"severity": {
"type": "number",
"description": "중증도(15 or 상/중/하 일시 1,2,3)"
},
"diseaseName": {
"type": "string",
"description": "병명"
},
"name": {
"type": "string",
"description": "환자 이름"
},
"birth": {
"type": "string",
"description": "환자 생일 (yyyy-MM-dd)"
},
"since": {
"type": "string",
"description": "병 발생 시기 (yyyy-MM-dd)"
}
}
},
"api-v1-dispenser-dispenserId-1160846675": {
"type": "object",
"properties": {
"patientId": {
"type": "number",
"description": "환자 ID"
}
}
},
"api-v1-patient-637801896": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "생성된 환자 ID"
}
}
},
"timestamp": {
"type": "string",
"description": "응답 시간"
},
"status": {
"type": "string",
"description": "응답 상태"
}
}
},
"api-v1-sound-1671860611": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"sounds": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "알림음 이름"
},
"id": {
"type": "number",
"description": "알림음 id"
},
"url": {
"type": "string",
"description": "알림음 url"
}
}
}
},
"count": {
"type": "number",
"description": "알림음 개수"
}
}
},
"timestamp": {
"type": "string",
"description": "응답 시간"
},
"status": {
"type": "string",
"description": "응답 상태"
}
}
},
"api-v1-drug2071534301": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"division": {
"type": "string",
"description": "분류 (일반의약품/전문의약품)"
},
"identifier": {
"type": "number",
"description": "약 고유식별번호"
},
"imageUrl": {
"type": "string",
"description": "약 이미지"
},
"shortLength": {
"type": "number",
"description": "길이(단측)"
},
"name": {
"type": "string",
"description": "약 이름"
},
"description": {
"type": "string",
"description": "약 외관에 대한 설명"
},
"id": {
"type": "number",
"description": "약 id"
},
"longLength": {
"type": "number",
"description": "길이(장측)"
},
"classification": {
"type": "string",
"description": "약 구분"
},
"produce": {
"type": "string",
"description": "제조사"
},
"thick": {
"type": "number",
"description": "두꼐"
}
}
},
"timestamp": {
"type": "string",
"description": "응답 시간"
},
"status": {
"type": "string",
"description": "응답 상태"
}
}
},
"api-v1-patient-patientId370834879": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "수정된 환자 ID"
}
}
},
"timestamp": {
"type": "string",
"description": "응답 시간"
},
"status": {
"type": "string",
"description": "응답 상태"
}
}
},
"api-v1-cartridge-cartridgeId-reminder-1638760233": {
"type": "object",
"properties": {
"schedules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"dayOfWeek": {
"type": "string",
"description": "요일 (MON, TUE, WED, THU, FRI, SAT, SUN)"
},
"time": {
"type": "string",
"description": "시간 (HH:mm:ss)"
}
}
}
}
}
},
"api-v1-cartridge-schedule916321208": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "생성된 카트리지 ID"
}
}
},
"timestamp": {
"type": "string",
"description": "응답 시간"
},
"status": {
"type": "string",
"description": "응답 상태"
}
}
},
"api-v1-user-1258169084": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "이름"
},
"profileImage": {
"type": "string",
"description": "프로필 이미지"
}
}
},
"timestamp": {
"type": "string",
"description": "응답 시간"
},
"status": {
"type": "string",
"description": "응답 상태"
}
}
},
"api-v1-cartridge-cartridgeId-1776866862": {
"type": "object",
"properties": {
"timestamp": {
"type": "string",
"description": "응답 시간"
},
"status": {
"type": "string",
"description": "응답 상태"
}
}
},
"api-v1-drug-autocomplete-1131437847": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"names": {
"type": "array",
"description": "검색 결과",
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"count": {
"type": "number",
"description": "총 검색 결과"
}
}
},
"timestamp": {
"type": "string",
"description": "응답 시간"
},
"status": {
"type": "string",
"description": "응답 상태"
}
}
},
"api-v1-cartridge-using-dispenserId1293555252": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"usingNumbers": {
"type": "array",
"description": "사용중인 번호",
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
},
"timestamp": {
"type": "string",
"description": "응답 시간"
},
"status": {
"type": "string",
"description": "응답 상태"
}
}
},
"api-v1-cartridge-cartridgeId-reminder-1719529968": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "등록된 카트리지 ID"
}
}
},
"timestamp": {
"type": "string",
"description": "응답 시간"
},
"status": {
"type": "string",
"description": "응답 상태"
}
}
},
"api-v1-user-name-1490293479": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "이름"
}
}
},
"timestamp": {
"type": "string",
"description": "응답 시간"
},
"status": {
"type": "string",
"description": "응답 상태"
}
}
},
"api-v1-cartridge1468055381": {
"type": "object",
"properties": {
"totalDoseDays": {
"type": "number",
"description": "총 투약 일수"
},
"dosage": {
"type": "number",
"description": "투여량"
},
"number": {
"type": "number",
"description": "카트리지 번호"
},
"reminderSoundId": {
"type": "number",
"description": "알람 사운드 ID"
},
"dispenserId": {
"type": "string",
"description": "디스펜서 ID"
},
"repeatable": {
"type": "boolean",
"description": "반복알림 여부"
},
"drugRemains": {
"type": "number",
"description": "남은 알약 갯수"
},
"memo": {
"type": "string",
"description": "메모"
},
"drugId": {
"type": "number",
"description": "약 ID"
},
"reminderTerm": {
"type": "number",
"description": "n일 간격 일시 시간 텀 (n 일 간격 외의 경우엔 -1, 시간(h))"
},
"doesPerDay": {
"type": "number",
"description": "1일 투여 횟수"
}
}
},
"api-v1-auth-kakao-refresh829476423": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"accessToken": {
"type": "string",
"description": "인증토큰"
},
"refreshToken": {
"type": "string",
"description": "리프레시 토큰 (기존 리프레시 토큰의 유효기간이 1개월 미만인 경우에만 갱신)"
}
}
},
"timestamp": {
"type": "string",
"description": "응답 시간"
},
"status": {
"type": "string",
"description": "응답 상태"
}
}
},
"api-v1-drug-check-dispenserId-1700343202": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"isCombinable": {
"type": "boolean",
"description": "혼용 가능 여부"
},
"caution": {
"type": "string",
"description": "주의사항"
}
}
},
"timestamp": {
"type": "string",
"description": "응답 시간"
},
"status": {
"type": "string",
"description": "응답 상태"
}
}
},
"api-v1-cartridge-cartridgeId-reminder-800630051": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "알람이 삭제된 카트리지 ID"
}
}
},
"timestamp": {
"type": "string",
"description": "응답 시간"
},
"status": {
"type": "string",
"description": "응답 상태"
}
}
},
"api-v1-patient-dispenser-dispenserId-350463104": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"severity": {
"type": "number",
"description": "중증도(1
5 or 상/중/하 일시 1,2,3)"
},
"diseaseName": {
"type": "string",
"description": "병명"
},
"name": {
"type": "string",
"description": "환자 이름"
},
"birth": {
"type": "string",
"description": "환자 생일 (yyyy-MM-dd)"
},
"id": {
"type": "number",
"description": "환자 ID"
},
"since": {
"type": "string",
"description": "병 발생 시기 (yyyy-MM-dd)"
}
}
},
"timestamp": {
"type": "string",
"description": "응답 시간"
},
"status": {
"type": "string",
"description": "응답 상태"
}
}
},
"api-v1-drug-check-dispenserId-633689209": {
"type": "object",
"properties": {
"drugNames": {
"type": "array",
"description": "추가하려는 약 이름",
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
},
"api-v1-drug-all646786864": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"drugs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"division": {
"type": "string",
"description": "분류 (일반의약품/전문의약품)"
},
"identifier": {
"type": "number",
"description": "약 고유식별번호"
},
"imageUrl": {
"type": "string",
"description": "약 이미지"
},
"shortLength": {
"type": "number",
"description": "길이(단측)"
},
"name": {
"type": "string",
"description": "약 이름"
},
"description": {
"type": "string",
"description": "약 외관에 대한 설명"
},
"id": {
"type": "number",
"description": "약 id"
},
"longLength": {
"type": "number",
"description": "길이(장측)"
},
"classification": {
"type": "string",
"description": "약 구분"
},
"produce": {
"type": "string",
"description": "제조사"
},
"thick": {
"type": "number",
"description": "두꼐"
}
}
}
},
"count": {
"type": "number",
"description": "검색 약 수"
}
}
},
"timestamp": {
"type": "string",
"description": "응답 시간"
},
"status": {
"type": "string",
"description": "응답 상태"
}
}
},
"api-v1-patient-dispenser-dispenserId486549215": {
"type": "object"
}
}
}
}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant