[web-services] / 로그인 또는 / 등록 리소스를 RESTfully 설계 하시겠습니까?

모바일 앱에 사용 되든 서버 간 통신에 사용 되든 다른 사용자를 위해 REST API를 구축하든 클라이언트를 위해 다양한 REST 웹 서비스를 통합 한 경험을 간단히 말씀 드리겠습니다. 다음은 다른 사람의 REST API에서 수집 한 몇 가지 관찰과 우리가 직접 구축 한 관찰입니다.

• API라고 할 때 일반적으로 프로그래밍 인터페이스 집합을 나타내며 프레젠테이션 계층이 필요하지 않습니다. REST는 또한 데이터 중심이며 프레젠테이션 기반이 아닙니다. 즉, 대부분의 REST는 JSON 또는 XML 형식으로 데이터를 반환하고 특정 프레젠테이션 레이어를 거의 반환하지 않습니다. 이 특성 (직접 웹 페이지가 아닌 데이터 반환)은 REST 기능을 통해 다중 채널 전달을 수행 할 수 있습니다. 동일한 웹 서비스를 HTML, iOS, Android로 렌더링하거나 서버 대 서버 조합으로 사용할 수도 있습니다.
• HTML과 REST를 URL로 결합하는 것은 매우 드뭅니다. 기본적으로 REST는 서비스로서의 생각이며 프레젠테이션 계층이 없습니다. 웹 서비스를 사용하는 사람들이 원하는대로 호출하는 서비스에서 데이터를 렌더링하는 것이 작업입니다. 그 시점에서 아래 URL은 지금까지 만난 대부분의 REST 기반 디자인 (Facebook 또는 Twitter에서 온 사람들과 같은 표준도 아님)과 일치하지 않습니다.

GET / register // 등록 양식이있는 웹 페이지를 가져옵니다.

• 이전 시점에서 계속해서 REST 기반 서비스가 아래에 제안 된 것과 같은 리디렉션을 수행하는 것은 드문 일입니다 (본 적이없는 경우도 있음).

GET / logout // 세션을 파괴하고 /로 리디렉션합니다.
POST / login // 데이터베이스에 대한 자격 증명을 인증하고 새 세션으로 홈을 리디렉션하거나 / login으로 다시 리디렉션합니다.
 

REST는 서비스로 설계되었으므로 로그인 및 로그 아웃과 같은 기능은 일반적으로 소비자가 해석 할 성공 / 실패 결과 (일반적으로 JSON 또는 XML 데이터 형식)를 반환합니다. 이러한 해석에는 귀하가 언급 한대로 적절한 웹 페이지로의 리디렉션이 포함될 수 있습니다.

• REST에서 URL은 취해진 조치를 나타냅니다. 따라서 가능한 한 많은 모호성을 제거해야합니다. 귀하의 경우에는 서로 다른 작업을 수행하는 동일한 경로 (예 : / register)를 가진 GET 및 POST를 모두 갖는 것이 합법적이지만 이러한 디자인은 제공되는 서비스에 모호성을 유발하고 서비스 소비자를 혼동 할 수 있습니다. 예를 들어 아래에서 소개하는 것과 같은 URL은 REST 기반 서비스에 적합하지 않습니다.

GET / register // 등록 양식이있는 웹 페이지를 가져옵니다.
POST / register // 입력 된 정보를 새로운 / user / xxx로 데이터베이스에 기록

그것들은 제가 다루었던 몇 가지 요점입니다. 나는 그것이 당신에게 약간의 통찰력을 줄 수 있기를 바랍니다.

이제 REST 구현을 위해 다음과 같은 일반적인 구현이 발생했습니다.

• GET / 로그 아웃
  

  백엔드에서 로그 아웃을 실행하고 작업의 성공 / 실패를 나타내는 JSON을 반환합니다.

• POST / 로그인
  

  백엔드에 자격 증명을 제출합니다. 성공 / 실패를 반환합니다. 성공하면 일반적으로 세션 토큰과 프로필 정보도 반환합니다.

• POST / 등록
  

  백엔드에 등록을 제출하십시오. 성공 / 실패를 반환합니다. 성공하면 일반적으로 성공한 로그인과 동일하게 처리되거나 별도의 서비스로 등록하도록 선택할 수 있습니다.

• / user / xxx 가져 오기
  

  사용자 프로필 가져 오기 및 사용자 프로필에 대한 JSON 데이터 형식 반환

• POST / user / xxx
  // 이름이
  POST / updateUser / xxx
  

  업데이트 된 프로필 정보를 JSON 형식으로 게시하고 백엔드에서 정보를 업데이트합니다. 성공 / 실패를 호출자에게 반환

답변

[HttpPut]
[Route("sessions/current")]
public IActionResult LogIn(LogInModel model) { ... }

[HttpDelete]
[Route("sessions/current")]
public IActionResult LogOff() { ... }