개발자의 오르막

[스프링 기반 REST API 개발 #02] EVENT REST API 본문

SpringFrameWork/SpringBoot

[스프링 기반 REST API 개발 #02] EVENT REST API

계단 2020. 3. 22. 20:58

# 이벤트 목록 조회 REST API ( 로그인 안 한 상태 )

- 응답에 보여줘야 할 데이터

  1) 이벤트 목록

  2) 링크

      self

      profile : 이벤트 목록 조회 API 문서로 링크

      get-an-event : 이벤트 하나 조회하는 API 링크

      next : 다음 페이지 ( optional )

      prev : 이전 페이지 ( optional )

 

- 문서 스프링 REST Docs

  https://spring.io/projects/spring-restdocs

 

Spring

Level up your Java code and explore what Spring can do for you.

spring.io

 

# 이벤트 목록 조회 REST API ( 로그인 한 상태 )

- 응답에 보여줘야 할 데이터

  1) 이벤트 목록

  2) 링크

      self

      profile : 이벤트 목록 조회 API 문서로 링크

      get-an-event : 이벤트 하나 조회하는 API 링크

      create-new-event : 이벤트를 생성할 수 있는 API ㄹ이크

      next : 다음 페이지 ( optional )

      prev : 이전 페이지 ( optional )

- 로그인 한 상태 : 헤더에 유효한 AccessToken 이 들어있는 경우

 

# Spring Hateoas

- https://spring.io/projects/spring-hateoas

 

Spring

Level up your Java code and explore what Spring can do for you.

spring.io

 

# Restlet Client 설치 링크

- chrome 웹스토어에 restlet client 검색 후 Talend API Test 를 설치한다.

- https://chrome.google.com/webstore/search/restlet%20client?hl=ko&_category=extensions

 

Chrome 웹 스토어

Chrome에 사용할 유용한 앱, 게임, 확장 프로그램 및 테마를 찾아보세요.

chrome.google.com

# Events API 사용 예제

 1. ( 토큰 없이 ) 이벤트 목록 조회

 2. access token 발급 받기 ( A 사용자 로그인 )

 3. ( 유효한 A 토큰 가지고 ) 이벤트 목록 조회

 4. ( 유효한 A 토큰 가지고 ) 이벤트 만들기

 5. ( 토큰 없이 ) 이벤트 조회

 6. ( 유효한 A 토큰 가지고 ) 이벤트 조회

 7. access token 발급 받기 ( B 사용자 로그인 )

 8. ( 유효한 B 토큰 가지고 ) 이벤트 조회

 

# REST API 테스트 클라이언트

- 크롬 플러그인 : Restled

- 애플리케이션 : Postman

Comments