swagger로 작성해본 API 명세 정보
swagger로 작성해본 API 명세
관련링크
본문
일단 현재 로그인된 회원의 정보에 접근하는 API만 작성해봤습니다.
신경쓰긴 했지만 놓친것도 있을 것같네요.
데이터와 함께 _links, _paging 노드를 포함하도록 했고,
오류 정보나 기타 리소스 등의 데이터가 추가될 수도 있겠네요.
스키마는 이정도 구성에서 당장 필요하지 않은 것들은 아직 작성하지 않았고
클라이언트가 그누보드 로직을 재구현하거나 언더패칭 문제가 없도록 구성해봤으나 좀 더 개선이 필요한 부분이 있을 것같네요.
추천
0
0
댓글 3개
HATEOAS
https://en.m.wikipedia.org/wiki/HATEOAS
HAL
https://stateless.co/hal_specification.html
_links 노드는 HAL 규격에 맞추려고 했으나 완전히 준수했는지는 다시 점검해봐야겠네요.
오류 표시는 아래 규격을 사용할 생각입니다.
https://www.rfc-editor.org/rfc/rfc7807
좀 더 범용적으로 사용하는 규격이 있다면 조언바랍니다.
https://en.m.wikipedia.org/wiki/HATEOAS
HAL
https://stateless.co/hal_specification.html
_links 노드는 HAL 규격에 맞추려고 했으나 완전히 준수했는지는 다시 점검해봐야겠네요.
오류 표시는 아래 규격을 사용할 생각입니다.
https://www.rfc-editor.org/rfc/rfc7807
좀 더 범용적으로 사용하는 규격이 있다면 조언바랍니다.
HAL이라는 규격을 가져온 것이 인상적입니다.
RESTful API를 만들 때 항상 나오는 지적이 기준이 될만한게 아무것도 없이 각자 지멋대로(?) 만든다인데, 저정도만 해도 그럴 걱정은 없을 것 같습니다.
RESTful API를 만들 때 항상 나오는 지적이 기준이 될만한게 아무것도 없이 각자 지멋대로(?) 만든다인데, 저정도만 해도 그럴 걱정은 없을 것 같습니다.
@어둠사자
응답 데이터가 어떠한 형태를 갖춰야한다는 구현체나 그 예시가 없기 때문에 별 수 없더라고요. 물론 정의가 있고 그것의 일부 구현 중 하나가 HAL이죠.
의외의 곳에서 잘 만들어진 API 디자인을 발견했고, 아디다스 API였습니다.
https://adidas.gitbook.io/api-guidelines/rest-api-guidelines/message/hal
의견 주셔서 감사합니다.
아무도 의견을 안 주셔서 힘이 빠지고 있던 참이네요^^;
응답 데이터가 어떠한 형태를 갖춰야한다는 구현체나 그 예시가 없기 때문에 별 수 없더라고요. 물론 정의가 있고 그것의 일부 구현 중 하나가 HAL이죠.
의외의 곳에서 잘 만들어진 API 디자인을 발견했고, 아디다스 API였습니다.
https://adidas.gitbook.io/api-guidelines/rest-api-guidelines/message/hal
의견 주셔서 감사합니다.
아무도 의견을 안 주셔서 힘이 빠지고 있던 참이네요^^;
