테스트 사이트 - 개발 중인 베타 버전입니다

그누보드/영카트 Swagger 문서화

· 4년 전 · 1124 · 2

완전 노가다네요..

 

그누보드5

http://74.208.22.155:3000/swagger/gnuboard5/

 

영카트5

http://74.208.22.155:3000/swagger/youngcart5/

 

각각을 클릭후 Try it out>Execute 를 눌러보면 출력되는 값을 볼 수 있습니다. (Postman 사용안해도.)

 

예를 들면

http://74.208.22.155:3000/swagger/gnuboard5/#/write-free/WriteFreeController_getById

에서 Try it out누르고 아이디 1을 넣고 Execute를 누르면, 아래와 같은 응답을 받을 수가 있습니다.

 

프런트엔드 단에서 사용은

post.wrId, post.wrSubject ....

post.wrLinks[0].link, post.wrLinks[0].hit

post.wrFiles[0].bfSouce

post.extras.wr_1

등으로 사용이 가능할 것 같습니다. (더 공부를 해서,  보다 더 직관적인 이름으로 변경해 보겠습니다.)

 

그누보드5

http://74.208.22.155:3000/swagger/gnuboard5/

 

영카트5

http://74.208.22.155:3000/swagger/youngcart5/

 

각각을 클릭후 Try it out>Execute 를 눌러보면 출력되는 값을 볼 수 있습니다. (Postman 사용안해도.)

 

예를 들면

http://74.208.22.155:3000/swagger/gnuboard5/#/write-free/WriteFreeController_getById

에서 Try it out누르고 아이디 1을 넣고 Execute를 누르면, 아래와 같은 응답을 받을 수가 있습니다.

 

프런트엔드 단에서 사용은

post.wrId, post.wrSubject ....

post.wrLinks[0].link, post.wrLinks[0].hit

post.wrFiles[0].bfSouce

post.extras.wr_1

등으로 사용이 가능할 것 같습니다. (더 공부를 해서, 보다 더 직관적인 이름으로 변경해 보겠습니다.)

 

[code]

{
  "post": {
    "wrId": 1,
    "wrNum": -1,
    "wrReply": "",
    "wrParent": 1,
    "wrIsComment": 0,
    "wrComment": 8,
    "wrCommentReply": "",
    "caName": "잡담",
    "wrOption": [
      "html1"
    ],
    "wrSubject": "flask(플라스크) 서평 이벤트에 당첨되었어요",
    "wrContent": "<p><img src=\"https://yc5.lavuebd.com/data/editor/2012/a8810e5e7fbd5907e2be8a5b60fd3e1c_1608708239_1957.jpg\" title=\"a8810e5e7fbd5907e2be8a5b60fd3e1c_1608708239_1957.jpg\" alt=\"a8810e5e7fbd5907e2be8a5b60fd3e1c_1608708239_1957.jpg\"></p><p style=\"color:rgb(34,34,34);font-family:'Apple SD Gothic Neo', 'Malgun Gothic', '맑은 고딕', sans-serif;font-size:14px;\">점프 투 파이썬의 저자님이 후속 책을 쓰셨고요</p><p style=\"color:rgb(34,34,34);font-family:'Apple SD Gothic Neo', 'Malgun Gothic', '맑은 고딕', sans-serif;font-size:14px;\"><a href=\"https://wikidocs.net/book/4542\" target=\"_blank\" style=\"color:rgb(7,130,193);\" rel=\"nofollow noreferrer noopener\">https://wikidocs.net/book/4542</a></p><p style=\"color:rgb(34,34,34);font-family:'Apple SD Gothic Neo', 'Malgun Gothic', '맑은 고딕', sans-serif;font-size:14px;\">위 링크에서도 책과 동일한 내용이 있습니다.</p><p style=\"color:rgb(34,34,34);font-family:'Apple SD Gothic Neo', 'Malgun Gothic', '맑은 고딕', sans-serif;font-size:14px;\">&nbsp;</p><p style=\"color:rgb(34,34,34);font-family:'Apple SD Gothic Neo', 'Malgun Gothic', '맑은 고딕', sans-serif;font-size:14px;\">&nbsp;</p><p style=\"color:rgb(34,34,34);font-family:'Apple SD Gothic Neo', 'Malgun Gothic', '맑은 고딕', sans-serif;font-size:14px;\">얼마전&nbsp;<a href=\"https://sir.kr/main/member/?mb_id=box2\" class=\"mention_user_info\" target=\"_blank\" style=\"color:rgb(7,130,193);font-weight:bold;\" rel=\"nofollow noreferrer noopener\">@박스2</a>&nbsp;님께서도&nbsp;</p><p style=\"color:rgb(34,34,34);font-family:'Apple SD Gothic Neo', 'Malgun Gothic', '맑은 고딕', sans-serif;font-size:14px;\">구입하신 책입니다.</p><p style=\"color:rgb(34,34,34);font-family:'Apple SD Gothic Neo', 'Malgun Gothic', '맑은 고딕', sans-serif;font-size:14px;\">&nbsp;</p><p style=\"color:rgb(34,34,34);font-family:'Apple SD Gothic Neo', 'Malgun Gothic', '맑은 고딕', sans-serif;font-size:14px;\">12월 14일 이후부터 읽기 가능할것 같습니다.</p><p style=\"color:rgb(34,34,34);font-family:'Apple SD Gothic Neo', 'Malgun Gothic', '맑은 고딕', sans-serif;font-size:14px;\">&nbsp;</p><p style=\"color:rgb(34,34,34);font-family:'Apple SD Gothic Neo', 'Malgun Gothic', '맑은 고딕', sans-serif;font-size:14px;\">서평은 처음인데&nbsp;</p><p style=\"color:rgb(34,34,34);font-family:'Apple SD Gothic Neo', 'Malgun Gothic', '맑은 고딕', sans-serif;font-size:14px;\">시작전에 인증글 남기고 갑니다.</p><p style=\"color:rgb(34,34,34);font-family:'Apple SD Gothic Neo', 'Malgun Gothic', '맑은 고딕', sans-serif;font-size:14px;\">&nbsp;</p><p style=\"color:rgb(34,34,34);font-family:'Apple SD Gothic Neo', 'Malgun Gothic', '맑은 고딕', sans-serif;font-size:14px;\">안녕히 주무세요.</p><p><br></p>",
    "wrSeoTitle": "flask플라스크-서평-이벤트에-당첨되었어요",
    "wrHit": 27,
    "wrGood": 4,
    "wrNogood": 2,
    "mbId": "sundoforce",
    "wrPassword": "",
    "wrName": "선구자",
    "wrEmail": "sundoforce@yc5.lavuebd.com",
    "wrHomepage": "",
    "wrDatetime": "2020-12-23T16:24:23.000Z",
    "wrFile": 2,
    "wrLast": "2020-12-23 16:29:14",
    "wrIp": "127.0.0.1",
    "wrFacebookUser": "",
    "wrTwitterUser": "",
    "wrLinks": [
      {
        "link": "https://wikidocs.net/book/4542",
        "hit": 1
      },
      {
        "link": "https://www.apachezone.com/free/6968",
        "hit": 0
      }
    ],
    "extras": {
      "wr_1": "",
      "wr_2": "",
      "wr_3": "",
      "wr_4": "",
      "wr_5": "",
      "wr_6": "",
      "wr_7": "",
      "wr_8": "",
      "wr_9": "",
      "wr_10": ""
    },
    "wrFiles": [
      {
        "boTable": "free",
        "wrId": 1,
        "bfNo": 0,
        "bfSource": "test.txt",
        "bfFile": "800597403_jcHK9GVR_5c4f0ace2c37d561a79ab8641bb9a46d1fd47ada.txt",
        "bfDownload": 0,
        "bfContent": "",
        "bfFileurl": "",
        "bfThumburl": "",
        "bfStorage": "",
        "bfFilesize": 146,
        "bfWidth": 0,
        "bfHeight": 0,
        "bfType": 0,
        "bfDatetime": "2021-03-21T11:29:49.000Z"
      },
      {
        "boTable": "free",
        "wrId": 1,
        "bfNo": 1,
        "bfSource": "test.csv",
        "bfFile": "800597403_KLjHBZ0o_75b19924e8f19d6d11600e22f7ed27e8b50d81d1.csv",
        "bfDownload": 0,
        "bfContent": "",
        "bfFileurl": "",
        "bfThumburl": "",
        "bfStorage": "",
        "bfFilesize": 149,
        "bfWidth": 0,
        "bfHeight": 0,
        "bfType": 0,
        "bfDatetime": "2021-03-21T11:29:49.000Z"
      }
    ]
  }
}

[/code]

 

@그누위즈 님의  그누보드 테이블 자료 와 영카트 테이블 자료 를 Swagger Doc에 넣어볼까 하는데,  허락해 주면,  시간나는데로 조금씩 이름을 변경해 볼려고 합니다.

댓글 작성

댓글을 작성하시려면 로그인이 필요합니다.

로그인하기

댓글 2개

4년 전
정말 대단하십니다.!! 저도 @마젠토 님의 게시물 보고 많이 배우고 있습니다.^^
@그누위즈 감사합니다

게시글 목록

번호 제목
262
259
255
250
248
245
238
234
233
232
229
228
227
222
217
216
215
212
210
208
203
195
192
188
184
180
177
173
170
165