search

pshpsh777 / atti-api-server

0 stars 0 forks source link

Rest APIs 명세서 작성 #4

Closed pshpsh777 closed 2 years ago

pshpsh777 commented 2 years ago

crud url 추가

yim0823 commented 2 years ago

rest api 룰에 따른 설계도 구글링해서 공부해보세요. 이미 아는 내용일꺼지만 도움될꺼에요

pshpsh777 commented 2 years ago

REST API 설계 Rules

REST : Representational State Transfer (해석이 안됨..)

정확한 의미가 뭔지 검색검색

REST는 리소스 상태를 전송하기 위한 아키텍쳐를 의미하고 이 방식을 적용한 설계를 Restful이라고 한다. Restful은 공식적으로 누군가 발표한 것이 아닌, 여러 개발자들이 비공식적으로 의견을 제시한 것으로 명확히 정해진 것은 없다. 즉, 개발자들마다 생각하는 Restful은 다를 수 있지만 목적은 명확하다. "이해하고 사용하기 쉬운 API를 만드는 것"

REST 아키텍처에 적용되는 6가지 제한 조건

REST API 기본 규칙

URI로 리소스를 표현하고

ref) https://one-it.tistory.com/entry/RESTful-API-%EC%84%A4%EA%B3%84-%EA%B7%9C%EC%B9%99 https://spoqa.github.io/2013/06/11/more-restful-interface.html https://sharplee7.tistory.com/49

yim0823 commented 2 years ago

해당 이슈 타이틀을 변경합니다.

해당 프로젝트의 APIs 명세서 작성 완료 후, close 진행 부탁드립니다.

pshpsh777 commented 2 years ago

기능 명세

회원

  1. 로그인 전화번호, 패스워드
  2. 로그인 시 사용자와 관리자 권한에 따라 다르게 제공한다.

관리자

사용자 관리

  1. 사용자 추가 전화번호, 패스워드, 이름, 나이, 주소, 등록날짜, 학교
  2. 사용자 수정
  3. 사용자 삭제
  4. 사용자 리스트 조회
  5. 사용자 상세정보 조회 (by Id)

    팀 관리

  6. 팀 추가 팀 이름, 수업요일, 수업시간
  7. 팀 삭제
  8. 팀 조회
  9. 팀 상세정보 조회
  10. 팀 상세정보 수정

    공지사항 관리

  11. 공지사항 등록 제목, 내용 , 타겟 팀
  12. 공지사항 수정
  13. 공지사항 삭제
  14. 공지사항 리스트 조회
  15. 공지사항 상세정보 조회 (by Id)

사용자

공지사항 조회

  1. 사용자가 속한 팀에 공지된 공지사항 리스트 확인
  2. 공지사항 상세내용 확인
yim0823 commented 2 years ago

기능 명세 토대로 Api 명세서 작성하면 되겠네요

pshpsh777 commented 2 years ago

https://github.com/pshpsh777/atti-api-server/wiki/API-%EB%AA%85%EC%84%B8

Wiki 페이지에 API 명세 작성했습니다! 혹시 이상한 부분 있으면 말씀 부탁드려요~