API명세서.md 3.94 KB
Newer Older
1
2
3
4
# API 명세서

## API 명세 Table

5
6
7
8
| Category       | HTTP Method | URI               | Description                                                 |
| :------------- | :---------: | :---------------- | :---------------------------------------------------------- |
| Root           |     ﹒      | /api              | 서버의 기본 경로                                            |
| Data Collector |     GET     | /data/input?...   | 아두이노를 통해 수집한 자료 등록 (내부, 외부는 쿼리로 구분) |
9
10
11
| Data           |     GET     | /data/user        | 사용자 지정 장소의 날씨 데이터 요청                         |
| Data           |     GET     | /data/outside/:id | 해당 지역구의 날씨 데이터 요청                              |
| Data           |     GET     | /data/loccode     | 행정 구역 코드 요청                                         |
12
13
| Auth           |    POST     | /signup           | 회원가입 요청                                               |
| Auth           |    POST     | /login            | 로그인 요청                                                 |
14
15
16
17
18
19
20
21
22
23
24
25
| Auth           |     GET     | /confirm?...      | 메일 인증용 토큰의 유효성 확인 요청                         |
| User Info      |     GET     | /user-info        | 회원 정보 요청                                              |
| User Info      |    POST     | /edit-profile     | 회원 정보 수정 요청                                         |
| User Info      |    POST     | /set-loccode      | 회원 지역 코드 설정 요청                                    |

<br><br>

## 주소 접근 방법

      [ "http://localhost:[your_port]" or "your_domain"]/api/---[URI]--

먼저 도메인을 입력 후, api서버의 기초 주소인 /api를 입력하고 위의 표 중 필요한 경로로 접근합니다.
26

27
<br><br>
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

## API 명세 기록

### 2021.05.03 \_ API 명세 초안 작성

1. Data Collector Routes
   : 데이터 수집기로 부터 정보를 전송하기 위함

- [x] 내부 데이터 수집기로 부터 데이터 전송
- [x] 외부 데이터 수집기로 부터 데이터 전송

2. API Routes
   : 최근 해당 지역구 및 사용자 등록 장소의 3시간 이내의 데이터를 그래프로 표현하기 위함

- [x] 사용자 가입 시 주소지 목록을 위한 경로 ( 도 / 시군구 / 읍면동)
- [x] 사용자 등록 장소(실내) Data
- [x] 사용자 지역구(외부) Data

3. Auth Routes
   : 사용자 등록, 확인 및 변경. 사용자 메인

- [x] 사용자 정보 변경 ( Edit )
- [x] 사용자 확인 ( Log-in )
- [x] 사용자 등록 ( Register )
KangMin An's avatar
KangMin An committed
52
53

      2021.05.07 +) Data Collector의 경우 Post 방식으로 보내주는 것이 맞으나, 현재 Get방식을 이용하고 있습니다. 올해 초 부터 아두이노에서 POST로 전송을 하고자 여러 자료를 찾아 봤지만, 방법을 찾지 못해 일단 진행 하였습니다. 방법을 발견하면 수정을 진행하겠습니다.
54

55
56
<br>

57
58
59
60
### 2021.07.12 \_ 경로 수정

1. 도 정보를 가져오는 경로 수정
   : loccode/do -> loccode/doe
61

62
63
<br>

64
65
66
67
68
69
70
### 2021.07.19 \_ 경로 수정

1. API 서버로의 기본 주소 수정
   : "/" -> "/api"

2. 행정 구역 코드 데이터 주소 수정
   : "도", "시/군/구", "읍/면/동"의 데이터를 따로 요청할 수 있던 것에서, 한번에 처리하도록 변경
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86

<br>

### 2021.07.26 \_ 경로 추가 및 분류 변경

1. 사용자 정보 주소 추가
   : 사용자의 정보를 요청하는 주소 추가 "/user-info"

2. 사용자 지역 코드 수정 주소 추가
   : 사용자의 지역 코드 수정 주소 "/set-loccode" 추가

3. 사용자 인증 주소 추가
   : 사용자가 메일을 통해 발급받은 주소로 이동시 토큰의 유효성을 검사하는 주소 "/confirm" 추가

4. 사용자 인증과 사용자 정보 주소 분류 구분
   : 사용자 인증에 관한 주소 "Auth", 사용자 정보에 관한 주소 "User Info" 분류 구분.