Development/Utils
[Utils] 쓸만한 VS Code extension들
Color Highlight #000000처럼 작성한 색깔 코드를 색으로 보여줍니다. Git Lens 코드가 언제 적혔는지, 누구에 의해 적혔는지 등등 코드 작성자에 대한 내용을 보여줍니다. Markdown Preview Mermaid Support & Markdown Editor 마크다운 에디터. mermaid와 md 파일을 미리보기로 보여줍니다. Prettier 코드 정렬해주는 기능입니다. TODO Tree & TODO Highlight 작성한 'TODO' 등의 태그를 하이라이트해서 보여주고, 그 태그들을 tree로 보여줍니다. 태그는 추가할 수 있습니다. ngrok 개발 중, 포트 우회가 필요할 때 사용하면 좋습니다.
[Utils] 마크다운 API 명세 템플릿
가능하다면 gitbook이나 swagger같은 공유 가능한 API 명세서를 쓰는 것이 제일 좋겠지만, 그렇지 못할 때는 markdown이라도 써서 API를 명세해야 합니다. 개인적으로 gitbook의 명세가 상당히 마음에 들어서 비슷하게 템플릿을 만들어 봤습니다. 적용한 모습은 다음 페이지에서 참고하면 됩니다. https://github.com/osamhack2022/APP_Meerkat_IQDan/wiki/API-Specification 코드는 아래와 같습니다. # 일반 API 명세 ![](https://img.shields.io/static/v1?label=&message=GET&color=blue) ![](https://img.shields.io/static/v1?label=&message=POST..
[Utils] API 설계 백그라운드
RESTful API 설계 가이드 https://sanghaklee.tistory.com/57 자주 사용하는 http status code https://gist.github.com/subicura/8329759 200번대 200 OK request 성공 ex) resource 목록/resource 상세/resource 수정/그외 대부분의 API 성공 성공 메시지가 날아오는 경우는 200이라고 생각해도 무방 201 Created request 성공 ex) resource 생성 성공 204 No Content request 성공 ex) resource 삭제 성공 300번대 301 move permanently 페이지 이동 307 temporary_redirect 임시 페이지 이동 400번대 400 Bad ..
[Utils] ngrok
사지방이나 container와 같은 환경에서 포트를 바꾸고 열어주려면 방화벽에 들어가 새로운 포트를 열어줘야 한다. 그러나, 귀찮다! 그래서 nrgok을 이용해 터널링으로 public에서 내 포트로 접속할 수 있게 열 수 있다. 아주 편리하다! 다음 링크에서 다운로드 받을 수 있다. [다운로드 링크] 다운로드 페이지에서 설치했다면 ngrok의 토큰을 등록해야 한다. 다음 링크에서 로그인을 하자. [ngrok 로그인] 로그인 했다면, 다음 링크에서 connect your account 부분을 복붙하자. [token 가져오기] 이후, 다음 명령어를 이용해 해당 포트로의 우회가 가능하다. ngrok http [PORT]