Skip to content

Commit fea27ef

Browse files
committed
docs: README.md 파일 수정
1 parent 92cb563 commit fea27ef

1 file changed

Lines changed: 34 additions & 1 deletion

File tree

README.md

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,18 @@ pip install Unoffical-TAGO-API
2929

3030
서비스 키는 [공공 데이터 포털 마이 페이지](https://www.data.go.kr/iim/main/mypageMain.do) 에서 확인하실 수 있고, Decoding키를 사용합니다.
3131

32+
---
33+
34+
주로 사용하는 변수/매개변수 이름 입니다:
35+
- `cityCode`: 도시코드
36+
- `routeNo`: 노선 번호
37+
- `routeId`: 노선 ID
38+
- `nodeId`: 정류소 ID
39+
- `nodeNm`: 정류소명
40+
- `nodeNo`: 정류소번호
41+
- `gpsLati`: WGS84 위도 좌표
42+
- `gpsLong`: WGS84 경도 좌표
43+
3244
## 사용 법
3345

3446
### 1. Client 생성
@@ -85,4 +97,25 @@ def from_list(cls, data:list): # 딕셔너리를 요소로 가진 리스트를
8597
노선의 도착 정보를 가지는 도메인 클래스 입니다.
8698

8799

88-
### 4. 오류
100+
### 4. API 사용
101+
102+
`get_route_by_no`: 버스 노선번호 목록을 조회
103+
104+
- 매개변수: `cityCode`, `routeNo`
105+
106+
`get_route_by_id`: 노선의 기본 정보를 조회
107+
- 매개변수: `cityCode`, `routeId`
108+
109+
`get_route_by_station`: 정류소의 경유노선 목록을 조회
110+
- 매개변수: `cityCode`, `nodeId`
111+
112+
`get_station_by_route`: 노선이 경유하는 정류소의 목록을 조회
113+
- 매개변수: `cityCode`, `routeId`
114+
115+
`get_station`: 정류소명과 정류소 고유번호를 이용하여 정류소의 정보를 검색
116+
- 매개변수_1: `cityCode`, `nodeNo`
117+
- 매개변수_2: `cityCode`, `nodeNo[Optical]`, `nodeNm`
118+
119+
`get_station_by_gps`: GPS좌표를 기반으로 근처(반경 500m)에 있는 정류장을 검색
120+
- 매개변수: `gpsLati`, `gpsLong`
121+
### 5. 오류

0 commit comments

Comments
 (0)