0419.txt

예언 야 소품이다 음 오늘은 다시 기술 기술 얘기인 것 문서와 얘기좀
이가 얘기할게요 예전에 이제 뭐 api 문서가 라던가 그런 비디오에서
어 문서와 를 어디까지 해야 되는데 얘길 했어요 그때 이제 나왔던 얘기
중에 제가 그런 얘기 란 게 뭐냐면 뭐 다른거 다 떠나고 그 중 하나의
이제 분석을 해야 될 게 아 외부의 이제 라이브러리를 주는 것들 그쵸
제 그런 이제 우리가 라이브를 외부 해주며 는 퍼블릭 함 수도 있잖아요
그 상기 호출 할 수있는
그럼 여기에 어떤 매개변수가 들어오고 이 함수는 무슨 일을 하는 거고
어떤 것을 바라느냐
이런걸 이제 함수 해도 같은데 박아주고
이제 그걸 자동으로 문서와 시키는 프로를 돌리며 좋다 라고 얘기를 했어요
뭐 사람마다 원하는 고 다르고 사람마다 하는 것 다 다르지만 저는 그렇게
하고 있다라고 그리고 또 예로 하라다 들었던 게
요즘은 이제 웹 api 가 만든 많잖아요 구글도 이제 뭐 데이터 api
이런거 있고
맵 api 있고 그랬고 외부로 가서 레스트 풀 그 api http 웹
호출로 즉 데이터 가져 오고 뭐 이런 것들 있잖아요
그러면 보통 그런 회사에서도 그런 공개된 외 api 들에 대해서 이건
이런거라고 문서작성을 하죠 그래서 저도 얘기했던 게 그 위에 역시 커멘트
달아 놓으면 좋다 라고 얘기 했어요
그리고 이제 그걸 자동으로 만드는 프로그램이 있다
그때 제가 그 프로그램을 제가 써 어떤거를 썼는지 얘기한 지도 모르겠지만
아 그 얘기를 지금 하려고 해요 어쨌든 간에 그 바탕이 담 내쪽으로 일단
얘기 할 거고
음 이건 웹 api 아까 말들 strap 아이의 한정된 얘기에요
예전에 그냥 as 비단 내에서 썼을 때는 음
as 안내 페이지를 만들면 mbc 애플리케이션을 만들면 거기에 해 프
페이지가 달려왔어요
그 헬프 페이지가 뭐냐 그러면 이미 컨트롤로 있고 다 라우터 있으니까
그리고 주석도 달려 있으니까 그거 따라 치가 알아서 따른 웹페이지를
만들어 주는 거였어요
스티 웹 페이지가 아니라 그 주소로 가면 은 어떤 api 가 있고 이게
102 변수가 어떤 데이터 형을 받는다 라고 보여주는 페이지가 있었어요
마이크로소프트 만 의 이제 스택 이었고 그 기본적은 api xp 로 를
썼고 하는 거지만 어쨌든 한 크기의 실시간으로 계속 보여주는 페이지가
있었죠
전에 비디오 에서도 말했지만 저는 그걸 안 좋아했어요
왜냐하면 은 아니 내 서비스는 서비스 하는거고 다큐멘트 페이지에 다큐멘트
페이지 왜 이것을 한 군데 다 됐냐 api strap 알았어 보면 따로
분리하고 다큐멘트 를 따로 분리하는 게 좋다
그 첫번째 있고 두 번째는 실제 외부의 다큐멘트 를 줄 때 제가 코드의
커 매트를 땅 단거 에 기초해서 나오는 건데 그 코드의 컨트롤 갈때마다
이제 테크니컬 라이터 라던가 이런 사람들 리뷰를 안 하잖아요 어차피
그러면 내가 새로운 api 만들고 실수 로 잘못 되었고
그냥 프라이스 안 만든 api 도 서버 가 어느 버전의 반응에 따라
잘못된 다큐 m 가 나올 수가 있는 거죠 그 한마디로 한번도 눈 을
거치는 과정이 없어서
아 조금 위험할 수 있다 코드를 위로 당연히 잡을 수 있지만 사람은 또
실수를 하니까 이런거를 한번더 누군가가 눈을 거쳐서 검수 하고
늙 내보내는 과정을 따로 만들면 크게 차라리 훨씬 더 안전하다
이게 스태틱 페이지를 만드는 과정이죠 그래서 스틱 페이지를 만드는 방법
자체가 없었어요
그 그 예습이 닷넷 코어 말고 그 전에 제가 어디서 코드 샘플 보고
거기서 비슷하게 한거 보고 가져와서
제가 심지어는 고 쳐맞고 기 터브 에 올려놓은 게 있어요
여기서 스틱 페이지 만들어내는 그 코드를 그러면 그 스트 페이지 뽑아
같고 이제 공유 말하면 되는데 문제는 아까 말했듯이 거는 마이크로소프트
자체의 기술이 얻고 흔히 저희가 요즘 보는 그런 그
그 뭐 api 다큐먼트 있잖아요 기 터브 가면 l api 5 하면서 까만
화면에 옆에 샘플 나오고
이런 다큐먼트 가 아니라 게 잦은 걔네 포멧이 나오고 그 꿈의 지도
맞다고 생각해요 느낌도 좀 어려워요 그래서 좀 혼자 동떨어진 느낌도
있었고 그래서 좀 안좋아 했는데 저희가 계단 내 코로 넘어와 짜 나요
단내 코에서는 훨씬 나은 방법이 있더라고요 그래서 이제 그거를 설명
드리려고 해요
단 4코어 에서는 음 그렇게 헬프 페이지가 딸려 오질 않아요 일단 무겁게
나오는거죠 뭐 추가하여 할 수도 있지만 기본적으로 딸려 오지 않아요
그러면 이제 어차피 부패 지 내가 안 쓸 거 였으니까 악보 메시 구리
니까 보다 보니까 이제 스와시 버클이 라는 그런 아 누 개 팩 씨가
있어요 그걸 다운받으면 은
헬프 페이지 처럼 그런 그런 약간
그 api 스펠을 뽑아 줘요 커멘트 에 기초해서 무슨 패러 m 기초해서
다 뽑아 줘요 리턴 타입은 이걸 거다 이런 것까지
그런데 이 거리 제이썬 파일을 뽑아주고 그제 있어니 뭐냐면 저희가 요즘
많이 쓰는 거예요
옆쪽에서 수애 거라는 게 있어요 스웨거 가 이제 이런 다큐멘트 같은거에
제 1선 스펙을 만들어서
이제 2 스펙 때로 이제 다큐멘트 를 만들어 주며 는 나중에 따른 어떤
수에 거 ui 라던가 이런 b 를 꼽으면 그것을 볼 수가 있다
그래서 실제 스 워 쉬 버클을 집어넣고 스타트업 에서 이거 세팅만
잘해주고
아이 api 그룹 뭐 버전 원으로 달린거 는 버전 원 url 로 들어가야
되고 제이썬 빠른 여기서 다운받을 수 있게 해 줘 제 있어 는 따른 것
영상다운 말 쓰게 해 줘 이렇게 잡아 주고 심지어는 그 아래에 아
유아인은 2페이지 고 그 ui 가면은 내가 지금 아까 제이썬 파일이 있는
그런 정해준 것들을 드랍 따온 박스로 골라가면서 아 이거는 퍼블릭 api
펑셔널 퍼블릭 api 버전 투 그렇게 보여주는 ui 가 나왔어요
그럼 이것은 말그대로 저희가 생각하는 소외 거 수애 그쪽에 있는 똑같은
스펙을 뽑아주기 때문에
음모 스펙이 터보 께 수해 건 아니지만 굉장히 눈에 익숙한 그런 눈썹 와
가 나오고 설명도 꽤 괜찮게 나와요 그리고 단 4코어 의 장점 중에
하나인 이제 c 샵에 장점이죠
모든 리턴 타입이 다 모든 인 플룻을 스톰 타입 할 수가 있잖아요 간
타이 퍼
감소와 그가 이제 뭐 무조건 스트링으로 받는게 아니라 얜 dt 오는 이런
클래스 오브젝트를 받는다 이런걸 해줄 수가 있기 때문에 그런 설명이 되게
잘 나오고 그 애트리뷰트 위에 아 있 엔릿 에이션 할 때 임프 펠리
대전할 때 스트링 길이는 뭐 몇 부터 마시고 숫자 범인 몇 부터 마시고
이런걸 달아주면 은 것도 다 문서에 지능을 다워요
그러면 이것을 하는 것만으로 그 헬프 페이지 아까 말했던 것처럼 그냥
라이브 서버에서 그 url 을
가면은 모든 현재 있는 커 매트에 기초한 문서를 볼 수가 있는 거에요
나쁘지 않지만 아까 말했던 한두 가지 문제가 여전히 있죠
헬프 페이지가 싫어했던 문제들 두가지가 그대로 있어
단 좋은 점은 아 이거는 다른거 하고 이제 사람들이 많이 웹에서 쓰는거
라고 비슷한 꼬 메시야 그래서 이렇게 좀 이질 저 지 않아 그런건 좀
좋은거 줘 그럼 그 다음에 제가 해야 할 일은 뻔했죠
아 여기서 스태틱 문서를 만들자
그래서 그 만드는 법을 사야 됐어요 어떻게 했냐면
아 잠깐만 영체가 이것도 적어 놓은게 있어서 그렇게 문서 하려는 되기
때문에 잠깐 보면서 얘기하는 게 좋을 것 같아요
일단 아까 말했던 것처럼 그 수애 것 악 설정 하는 거 있었잖아요
그가 까서 url 여기가면 제이썬 받고 여유가 많이 ui 나온다 이런거
그럼 결과적으로 제가 필요한건 제이썬 파일이 에요 그 제이썬 파에서
htm 으로 만들면 되는 거니까
서버 설정을 어떻게 하냐며 는 스웨거 이렇게 제 2선 파일 제공 하는
그런 u 알의
아 저희 실제 내부 테스트 서버에서 만 돌게 만들어 놓았고 실습을 올라갈
때는 이게 아예 설정을 한 해 줘라
그럼 실 수업에서는 볼 일이 없어요 그럼 저희는 문서로 앉다 어떻게
만드냐
완벽히 자동화 시키면 빌드를 하잖아요
새로운 서버 버전을 필드를 해요 그러면 이 빌드 항거를 저희 테스트
서버에 올려요
한테 서버는 아까 말했듯이 내부 써보니까 j 썸 파일을 다운받을 수 있는
url 있어요
그러면 빌드 스텝 등의 하나로 그 제이썬 을 다운받아 요 금 j 선바위
다운받지 요 그럼 그 다음에
노드 js 에서 쓰는 어떤 패키지를 써서
이제 있어 는 html 로 바꿀 수가 있어요 그렇게 html 을 그리고
따른 스탈이 따라 나오죠
이거를 이제 저희 실제 더 플레이트 서버에 업로드 하는 것만으로 다 끝이
날
그래서 그 과정을 저희가 만들었고 아직 완벽히 자동 안 됐지만 이제 그
자동 어리지 조만간 할 거에요 그러면 아 이 스웨거 제이썬 파일을 택시
채널을 바꿀 수 있는 그 노드 js 패키지가 뭐냐
날
발음이 내가 될 것 10팩 테크 실패 테클 닥스 라고 있어요
까 이제는 mpm 다운받는데 뭐 밑에 다윗 링크는 제가 걸던 갈게요
뭐 mpn 이스터 라고 이제 스펙 테클 닭을 한 다음에 스펙 테크 -
닥스 해요
그런 다음에 그 냥 스펙 티클 뭐 어쩌구 제이썬 실행하며 는 곧바로 h
팀의 나와요
그리고 그것만으로 이제 아까 말했던 즉 이 토브 에서 보는 것 같은 까만
화면에 힘과 가운데 있고 욥의 셈플 나오는 그 닭이 나와요
그러면 이제 재밌는거 뭐냐면
이걸 자동화 에서 닭이 나오고 실제 닭 서버 까지 올라갈 수가 있다고
얘기 했잖아요
그럼 닭 서버 에 올라 가기전에 저희는 일단 라이브에 꼽아 두고
라이브 가 아니어서 내부 서버 이제 꼽아 두고 걸 딱 보여주고 이게 실제
스틱 나갈 거다
그리고 이 저희는 테크니컬 라이터 드 리뷰를 시키는 거에요 아니면 저희가
검토 해 왔고 아이고 빠졌다 을 추가해서 다시 빌드하고
테크닉과 라이터가 보면서 이제 개발자 영어 보다는 테크니컬 라이팅 하고
하심 좋을 수밖에 없잖아요
i 문장 이렇게 고치자 라고 전에 첨언을 해주며 는 저희가 가서 다시
주석에서 바꿔서 빌드하고 나가고 다시 검토 받고 최종까지 나가면 되는
거죠 그래서 자동화 플러스 딱 게이트 방 는거 허가 안나가면 라이브
안나가 이거 다 이제
비주얼스튜디오 온라인에서 빌드하고 디플롬 에다 설정할 수 있는 기능들
중에 한 하거든요 그래서 그거를 저희가 이제 만들었고 저희는 그래서
라이브 다
뜬 일단 같은 서브 안되니까 좋고 에스테틱을 html 나왔으니까 굉장히
캐시 빠르고 빠르고
그래서 아 이게 갈 길이 구나 단 중간에 테크니컬 라이터 를 꼭 읽고
봐야 하지만 뭐 거야 어쩔수 없는거고 당연히 비즈니스의 일부 인거고
그래서 그렇게 api 의 다들
자동화를 하되
스태틱 페이지를 나오게 하고 타인을 페이지가 아니라 그리고 남들이 다
기대하는 게 예쁘고 까맣고 하얀 그 api 닭을 만드는 과정을 저희
찾아냈어요
그래서 담배 코 쓰시는 분들중에
아 단 데코 만은 아닐 거야 제이썬 파일만 나올 수 있다면 그저 어떤거
에도 똑같은 과정이죠
이제 스웨거 쪽을 특히 즉 보시는 분들이나 좀더 포맷을 제대로 손 꼬마를
안하고 좀 커멘트 에서 뽑고 싶은 사람들 그런 사람도 이런 방식으로 하면
될것 같아요
물론 예수회가 닭은 만드는 문제고 스웨거 닭을 나오게 하는 다름
이제 누계 패키지나 아니면 따른 이제 언어 용 따른 프레임워크 용 모
패키지가 있겠죠
그런 패키지를 잘 쓰는게 중요한 거겠죠 그냥 다 내 코 자체는 이미
예전부터 그런 일을 해 오고 있었기 때문에 xml 문서와 라던가 컴에 t
기초에서 자 바닥이 랑 비슷한 거죠
그거를 써서 이걸 이걸 이걸 연결 하면 우리가 기대하는 가장 좋은 즉
좋은게 문서가 나올 수 있다 라는 걸 발견하고 좋았고
이제 저희 회사에서 하고 있고 그래서 고민을 했어요 본서 와 를 하셔야
하는 분들은 그런 방향으로 좀 고민을 하시면
삽질하는 시간이 좀 적겠죠 그리고 아마 문서를 따로따로 손으로 짜는 거
때문에 시간낭비 언어도 적겠죠
그거를 제 알아 보시라고 지식공유 허접한 거지만 지공을 했어요
예 뽑혔습니다