마법사가있는 웹 페이지를위한 REST API 디자인

마법사 형식의 웹 페이지가 있습니다. API 제출 버튼은 마법사의 4 단계에 있습니다. 그러나 마법사의 다음 단계로 이동하기 전에 입력 한 데이터를 데이터베이스에 저장하려고합니다. 또한 단일 탭이있는 페이지에서 REST API가 작동하기를 원합니다.

그래서 쿼리 매개 변수 action = draft 또는 submit을 수행하도록 API를 설계했습니다. 조치가 초안 인 경우 특정 필드 만 필수입니다. 조치가 제출되면 모든 필드가 필수입니다. REST API의 서비스 계층에서 유효성 검사는 쿼리 매개 변수를 기반으로 수행됩니다. 설명서에서 if / else 절을 ​​명시 적으로 지정해야합니다. 이것이 RESTful 디자인의 수용 가능한 형태입니까? 이러한 요구 사항에 가장 적합한 디자인은 무엇입니까?

마법사 단계 사이에 서버에있는 것들을 유지하고자하므로 각 단계를 별도의 리소스로 간주하는 것이 좋습니다. 이 라인을 따라 뭔가 :

POST /wizard/123/step1
POST /wizard/123/step2
POST /wizard/123/step3

응답에 하이퍼 미디어 링크를 포함 시키면이 단계 이후에 수행 할 수있는 작업에 대해 클라이언트에게 알릴 수 있습니다. 중간 단계는 앞뒤로 진행하고 마지막 단계는 수행하지 않습니다. 당신은 그림 5에서의 예를 볼 수 있습니다 여기에 .

나는 얼마 전에 비슷한 일을해야했고, 다음은 우리가 끝내는 것을 설명합니다.

Item과 UnfinishedItem이라는 두 개의 테이블이 있습니다. 사용자가 마법사를 사용하여 데이터를 입력하면 데이터가 UnfinishedItem 테이블에 저장됩니다. 각 마법사 단계에서 서버는 해당 단계 동안 입력 된 데이터의 유효성을 검사합니다. 사용자가 마법사를 마치면 마법사는 확인 페이지에 숨겨진 / 읽기 전용 양식을 렌더링하여 제출할 모든 데이터를 표시합니다. 사용자는이 페이지를 검토하고 관련 단계로 돌아가 오류를 수정할 수 있습니다. 사용자가 항목에 만족하면 제출을 클릭하면 마법사가 숨겨진 / 읽기 전용 양식 필드의 모든 데이터를 API 서버에 제출합니다. API 서버는이 요청을 처리 할 때 마법사의 각 단계에서 수행 한 모든 유효성 검사를 다시 실행하고 개별 단계에 맞지 않는 추가 유효성 검사 (예 : 전역 유효성 검사, 값 비싼 유효성 검사)를 수행합니다.

두 가지 테이블 접근 방식의 장점 :

• 데이터베이스에서는 UnfinishedItem 테이블보다 Item 테이블에 더 엄격한 제한 조건을 가질 수 있습니다. 마법사가 완료 될 때 실제로 필요한 선택적 열이 없어도됩니다.

• 완료되지 않은 항목을 제외하는 것을 기억할 필요가 없으므로 완성 된 항목에 대해보고를위한 집계 쿼리가 더 쉽습니다. 이 경우 Item과 UnfinishedItems간에 집계 쿼리를 수행 할 필요가 없었으므로 문제가되지 않습니다.

단점 :

• 유효성 검사 논리가 복제되기 쉽습니다. 우리가 사용했던 웹 프레임 워크 인 Django는 약간의 메타 마술과 함께 모델 상속을 사용하여 Item과 UnfinishedItem에서 달라야하는 제약 조건을 변경함에 따라 이것을 좀 더 견딜 수있게 만들었습니다. Django는 대부분의 데이터베이스와 양식 유효성 검사를 모델에서 생성하므로 그 위에 몇 가지 추가 유효성 검사 만 해킹하면됩니다.

내가 고려한 다른 가능성과 왜 우리가 그들과 함께 가지 않았습니까?

• 쿠키 또는 로컬 저장소에 데이터 저장 : 사용자는 다른 기기에서 제출을 계속하거나 브라우저 기록을 삭제 한 경우
• UnfinishedItem을 데이터베이스 또는 보조 데이터 저장소에 구조화되지 않은 데이터 (예 : JSON)로 저장합니다. 구문 분석 논리를 정의해야하며 Django의 자동 모델 / 양식 유효성 검사를 사용할 수 없습니다.
• 클라이언트 측에서 단계별 유효성 검사를 수행하십시오 .Python / Django와 JavaScript간에 유효성 검사 논리를 복제해야합니다.

나는 @ guillauma31과 @Lie Ryan의 솔루션과 비슷한 방식으로 이것을 구현했습니다.

주요 개념은 다음과 같습니다.

1. 완료 될 때까지 부분적으로 지속될 수있는 3 단계 마법사가 있습니다.
2. 각 단계 (예 : 그것의 자신의 자원을 가지고 /users/:id_user/profile/step_1, .../step_2등)
3. 각 단계에서 데이터 및 완료 상태는 GET 요청을 통해 검색되고 PATCH 요청을 통해 지속될 수 있습니다.
4. 각 리소스에는 입력 한 데이터에 대한 자체 유효성 검사 규칙이 있습니다.
5. 각 단계는 시퀀스를 보장하기 위해 다음 단계의 입력에 사용해야하는 키를 반환합니다. 사용되거나 새로운 토큰이 생성되면이 토큰은 만료됩니다.
6. 마지막 단계에서 데이터베이스에 필요한 모든 데이터가 있으며 확인 화면이 표시됩니다. 이 확인은 다른 리소스를 호출하여 데이터를 완료된 것으로 표시합니다 (예 :) .../profile/confirm. 이 리소스는 모든 데이터를 다시받을 필요가 없습니다. 데이터가 정확하고 완전한 것으로 표시됩니다.
7. 이 불완전한 항목을 며칠 이상 지운 예약 된 루틴이 있습니다.

프론트 엔드 녀석은 마법사의 앞뒤 흐름을 작동시키기 위해 토큰을 관리해야합니다.

API는 상태가없고 원자 적입니다.

이 설정에서 "1 단계 마법사"를 사용하려면 토큰 흐름 제거 또는 마법사 유형에 따라 토큰을 반환 할 리소스 생성 또는이 특정 단일 항목 만 채울 새로운 리소스 생성과 같은 몇 가지 사항을 변경해야합니다. 단계 마법사 (예 :) PUT /users/:id_user/profile/.