api_spec

• 개요
• 회원 API
  • 회원가입
  • 로그인
  • 로그아웃
• 카테고리 API
  • 카테고리 조회
  • 카테고리 생성
  • 카테고리 수정
  • 카테고리 삭제
• 커뮤니티 피드 게시판 API
  • 커뮤니티 게시판 조회
  • 커뮤니티 회원별 게시판 조회
  • 커뮤니티 특정 게시물 조회
  • 커뮤니티 게시물 작성
  • 커뮤니티 게시물 수정
  • 커뮤니티 게시물 삭제
• 산림청 국립수목원_식물자원 서비스 API
  • 식물 도감 목록 검색
  • 식물 도감 상세정보 조회

개요

• api 스펙

회원 API

회원가입

• api: /api/v1/user/signup
• http method: POST
• 요청 헤더

Content-Type: application/json;charset=UTF-8

• request_body

{
    "email": "hello@world.com",
    "password": "password",
    "nickname": "testuser"
}

• 성공 응답

201 CREATED
{
  "id": "1" ; 생성 id
}

로그인

• api: /api/v1/user/login
• http method: POST
• request_body: form-data

{
  "email": "",
  "password": ""
}

• 성공 응답
  • status_code: 200 OK
  • cookie: 세션id가 JSESSIONID로 리턴
• 실패 응답
  • status_code: 401 Unauthorized

로그아웃

• api: /api/v1/user/logout
• http method: POST
• 요청 헤더

Content-Type: application/json;charset=UTF-8

• request_body

{
}

• 성공 응답

200 OK

카테고리 API

카테고리 조회

• api: /category
• http method: GET
• 요청 헤더

Content-Type: application/json;charset=UTF-8

카테고리 생성

• api: /category
• http method: POST
• 요청 헤더

Content-Type: application/json;charset=UTF-8
cookie: "JESSIONID: <id>"

• request_body

{
    "name": "",
    "parentId": 0L
}

카테고리 수정

• api: /category/{category_id}
• http method: PUT
• 요청 헤더

Content-Type: application/json;charset=UTF-8
cookie: "JESSIONID: <id>"

• request_body

{
    "name": "",
    "parentId": ""
}

카테고리 삭제

• api: /category/{category_id}
• http method: DELETE
• 요청 헤더

Content-Type: application/json;charset=UTF-8
cookie: "JESSIONID: <id>"

커뮤니티 피드 게시판 API

커뮤니티 게시판 조회

• api: /board
• http method: GET
• 요청 헤더

Content-Type: application/json;charset=UTF-8

커뮤니티 회원별 게시판 조회

• api: /board/{account_id}
• http method: GET
• 요청 헤더

Content-Type: application/json;charset=UTF-8

커뮤니티 특정 게시물 조회

• api: /board/{board_id}
• http method: GET
• 요청 헤더

Content-Type: application/json;charset=UTF-8

커뮤니티 게시물 작성

• api: /board
• http method: POST
• 요청 헤더

Content-Type: application/json;charset=UTF-8
cookie: "JESSIONID: <id>"

• request_body

{
    "content": "",
    "account": {}
}

커뮤니티 게시물 수정

• api: /board/{board_id}
• http method: PUT
• 요청 헤더

Content-Type: application/json;charset=UTF-8
cookie: "JESSIONID: <id>"

• request_body

{
    "content": "",
}

커뮤니티 게시물 삭제

• api: /board/{board_id}
• http method: DELETE
• 요청 헤더

Content-Type: application/json;charset=UTF-8
cookie: "JESSIONID: <id>"

[산림청 국립수목원_식물자원 서비스 API]

식물 도감 목록 검색

• api: /plntIlstrSearch
• request_body

{
  "st": "1",
  "sw": "",
  "numOfRows": "10",
  "pageNo": "1"
}

식물 도감 상세정보 조회

• api: /plntIlstrInfo?q1=?
• request_heder 도감번호

https://www.data.go.kr/iim/api/selectAPIAcountView.do