[미세먼지] API 리소스 / URL 정의

[tea7day]

1. API 요청 URL

예시

• [GET] /api/v1/findusts?type="general"&province="서울"

파라미터 설명

type

• 설명: 미세먼지 유형
• 허용값: [general|detail]

province

• 설명: 미세먼지 측정 지역
• 값예시: [서울|경기|강원|부산|인천등]
• default: 서울

2. API 응답 리소스 - 정상

예시

{
  fineDusts: {
      dateTime: '2018-05-21T08:00:00',
      province: 서울,
      figure: 300,
      status: good,
  }
}

필드 설명

dateTime

• 설명: 측정시간

province

• 설명: 미세먼지 측정 지역
• 값예시: [서울|경기|강원|부산|인천등]

figure

• 설명: 미세먼지 농도
• 크기: 1.0~1000.0

Status

• 설명: 미세먼지 상태
• 허용값: [best|good|normal|bad|worst]

API 응답 리소스 - 에러

예시

{
  code: 'TypeRequired', // 필수
  reason: '타입정보는 꼭 필요합니다.' // 옵션
}

필드 설명

code

• 설명: 에러 코드

reason

• 설명: 에러 설명

API 상태코드

• 200: OK
• 400: BadRequest
• 404: Not Found
• 500: Server Error

[tea7day]

단순 텍스트와 리스트형태로 API를 정의 하는 게 불편하다.

OpenAPI Specipication으로 재작성이 필요하다.

[deokju]

api 개발이 많이 지연되고 있습니다. datetime UTC로 주는것과 status 가 수,목 2일 중으로 처리 될 예정 입니다. 이상입니다.