이전 글 https://sir.kr/so_app/1914 에 이어서 swagger doc도 배우는데 오래 걸리네요.
그래서 그냥 만들어 봤습니다. 링크는 @그누위즈 님을 참조 했습니다.
그누보드
g5_auth
g5_autosave
g5_board
GET /boards
~~GET /board[s]/settings~~
g5_board_file
GET /board/[bo_table]/[wr_id]/files
g5_board_good
GET /board/[bo_table]/[wr_id]/good
g5_board_new
GET /boards/new_articles
GET /boards/new_comments
g5_cert_history
g5_config
GET /configs
g5_content
GET /contents
GET /contents/[co_id]
g5_faq
GET /faqs
GET /faqs/[fa_id]
g5_faq_master
GET /faqsgroup/[fm_id]
g5_group
GET /groups
g5_group_member
g5_login
g5_mail
g5_member
GET /members
GET /member/[mb_id]
g5_member_social_profiles
g5_memo
g5_menu
GET /menus
g5_new_win
g5_point
GET /member/[mb_id]/points
g5_poll
g5_poll_etc
g5_popular
g5_qa_config
g5_qa_content
g5_scrap
GET /member/[mb_id]/scraps
g5_uniqid
g5_visit
g5_visit_sum
g5_write_[bo_table]
게시판 당 하나씩 생성되어 글과 댓글이 저장되는 테이블
GET /board/[bo_table]
GET /board/[bo_table]/[wr_id]
GET /board/[bo_table]/[wr_id]/good
GET /board/[bo_table]/[wr_id]/files
GET /board/[bo_table]/[wr_id]/comments
GET /board/[bo_table]/[wr_id]/comment/[wr_id]
GET /board/[bo_table]/[wr_id]/comment/[wr_id]/good
GET /board/[bo_table]/[wr_id]/comment/[wr_id]/files
댓글 12개
잘 모르는 필드도 있고해서, 우선 생각나는 것만(GET만) 적어 봤습니다. 혹시에 앱 또는 RESTFul에 관심이 있으신분은 댓글로 필요한 것 또는 고려해야 될 API 를 알려주세요.
즉
GET /board/[bo_table]/group 하면 해당 게시판의 그룹을 읽어 오는 것이죠
GET /board/[bo_table]/group/members 하면 게시판 그룹의 그룹멤버를 읽어 오는 것이죠.
RESTFul의 단점이 쓸데 없이 많은 트랙픽을 유발한다고 합니다.
그래서 요즘은 Graphql이란 것을..
{ board: [bo_table] {
id,
group,
group_member
}
대략 필요한 필드를 보내면 한번에 정리해서 보내주는 식입니다.
즉
GET /board/[bo_table]/group 하면 해당 게시판의 그룹을 읽어 오는 것이죠
GET /board/[bo_table]/group/members 하면 게시판 그룹의 그룹멤버를 읽어 오는 것이죠.
RESTFul의 단점이 쓸데 없이 많은 트랙픽을 유발한다고 합니다.
그래서 요즘은 Graphql이란 것을..
{ board: [bo_table] {
id,
group,
group_member
}
대략 필요한 필드를 보내면 한번에 정리해서 보내주는 식입니다.
@Rido 링크에 업데이트 하고 있습니다.
JWT 토큰 발행하고 Postman Authorization에 Bearer토큰에 넣어서 체크됩니다.
[http://sir.kr/data/editor/2012/aa98b393091d5166057a9ff54adb3080_1609224071_6218.PNG]
GET /member/[mb_id]/autosave
GET /member/[mb_id]/points
GET /member/[mb_id]/scraps
GET /member/[mb_id]/memo/[me_recev_mb_id]
GET /member/[mb_id]/memo/[me_send_mb_id]
그리고 확장자도 따로 읽어 볼까 합니다.
GET /member/[mb_id]/exts
GET /member/[mb_id]/ext/[mb_?]
프런트엔드단과 어느정도 맞춰서 API가 규정이 되면 좋은데,
실력이 양쪽을 왔다갔다할 정도는 안되서..
backend만들면 잊어버리고, 다시 프런트엔드로 ㅠㅠ
JWT 토큰 발행하고 Postman Authorization에 Bearer토큰에 넣어서 체크됩니다.
[http://sir.kr/data/editor/2012/aa98b393091d5166057a9ff54adb3080_1609224071_6218.PNG]
GET /member/[mb_id]/autosave
GET /member/[mb_id]/points
GET /member/[mb_id]/scraps
GET /member/[mb_id]/memo/[me_recev_mb_id]
GET /member/[mb_id]/memo/[me_send_mb_id]
그리고 확장자도 따로 읽어 볼까 합니다.
GET /member/[mb_id]/exts
GET /member/[mb_id]/ext/[mb_?]
프런트엔드단과 어느정도 맞춰서 API가 규정이 되면 좋은데,
실력이 양쪽을 왔다갔다할 정도는 안되서..
backend만들면 잊어버리고, 다시 프런트엔드로 ㅠㅠ
@볼피드 지금까지 공부한 것을 기반으로(이론적으로) Doc을 먼저 만들어 놓고. (그래서 버전0.2) 조금씩 구현해 볼려고 합니다.
워낙 고려해야 될 것도 많고, 그누보드쪽도 아직 잘 모르다 보니,
조금씩 구현해 가면서, 서로 업그레이드 해 가면 좋을 것 같습니다.
능력이 안되니, 백엔드와 프런트엔드 모두 해 가면서 이쪽에서 필요한 것 저쪽에서 해 주고, 저쪽에서 구현하기 힘든것은 아래쪽에서 해 주면 좋은데.. 그게 힘드네요.
그래서, 이렇게라도 Document를 해 놓으면 모두가 도움이 되지 않을까요?
냑에서도 6.0나오는 시점에 RESTful을 지원한다고 하면, 이것도 하나의 기준이 될 수도 있고,
기능적으로 큰 문제가 없다고 하면, 굳이 다르게 갈 필요도 없겠죠..
프런트단 구현해 가면서 필요한 기능이 있으면, 같이 토의해 가면서 만들었으면 합니다.
워낙 고려해야 될 것도 많고, 그누보드쪽도 아직 잘 모르다 보니,
조금씩 구현해 가면서, 서로 업그레이드 해 가면 좋을 것 같습니다.
능력이 안되니, 백엔드와 프런트엔드 모두 해 가면서 이쪽에서 필요한 것 저쪽에서 해 주고, 저쪽에서 구현하기 힘든것은 아래쪽에서 해 주면 좋은데.. 그게 힘드네요.
그래서, 이렇게라도 Document를 해 놓으면 모두가 도움이 되지 않을까요?
냑에서도 6.0나오는 시점에 RESTful을 지원한다고 하면, 이것도 하나의 기준이 될 수도 있고,
기능적으로 큰 문제가 없다고 하면, 굳이 다르게 갈 필요도 없겠죠..
프런트단 구현해 가면서 필요한 기능이 있으면, 같이 토의해 가면서 만들었으면 합니다.
게시글 목록
| 번호 | 제목 |
|---|---|
| 1891 | |
| 1879 | |
| 1874 | |
| 1873 | |
| 1867 | |
| 1866 | |
| 1862 | |
| 1861 | |
| 1855 | |
| 1854 | |
| 1853 | |
| 1851 | |
| 1850 | |
| 1849 | |
| 1848 | |
| 1847 | |
| 1841 | |
| 1840 | |
| 1835 | |
| 1833 | |
| 1825 | |
| 1824 | |
| 1820 | |
| 1819 | |
| 1814 | |
| 1811 | |
| 1810 | |
| 1809 | |
| 1808 | |
| 1805 |
댓글 작성
댓글을 작성하시려면 로그인이 필요합니다.
로그인하기