Swagger UI를 사용하기 위해서는 install이 필요없이 build또는 recompile을 해야합니다. 

Github 주소에 접속해서 swagger-ui 코드를 clone이 가능합니다. 


Swagger UI 코드 가져오기 


github 주소 - https://github.com/swagger-api/swagger-ui

$ git clone https://github.com/swagger-api/swagger-ui.git



사용하는 방법


nodejs 4.0 이상을 설치해야 합니다. 


$ cd swagger-ui

$ npm install

$ npm run build

$ npm run serve

을 실행하면 서버가 실행된다. 

http://localhost:8080/

으로 접속이 가능하다. 




Docker에서 실행하기


물론 docker를 사용하기 위해서는 docker가 설치가 되어 있어야 한다.

$ docker pull swaggerapi/swagger-ui

$ docker run -p 80:8080 swaggerapi/swagger-ui




Docker사용해서 build하기


$ docker build -t swagger-ui-builder .

$ docker run -p 80:8080 swagger-ui-builder


Swagger UI를 http://localhost로 실행이 가능하다.



Pull Requests

  외부 프로젝트를 fork를 했을때, 내가 변경한 내용을 반영하고 싶을 때가 있습니다. 어떤 코드 변경을 했는지 기존 프로젝트의 maintainer에게 요청을 전송합니다. 요청을 전송하면 maintainer는 요청을 보고, 리뷰를 한 뒤에 accept을 하면 내가 요청한 변경 사항을 pull을 합니다. 그렇게 되면 기존에 내가 fork한 프로젝트에 반영이 됩니다. 이처럼 나의 변경사항을 기존 프로젝트의 maintainer에게 요청하는 작업을 pull requests를 만든다 라고 표현합니다. 


Pull Request 생성하기

  Pull Request를 생성하기 위해서는 기존 github에서 내가 fork한 프로젝트의 저장소를 방문합니다. github에서는 'Compare & pull request'의 버튼이 보입니다. 누르고 나서, 'Create pull request'를 누른다음, 나의 변경사항에 대해서 title과 description을 작성합니다. github에서는 나의 github의 branch와 기존 fork한 github의 branch와 변경된 사항이 없으면, 화면에 변경사항이 없다고 나옵니다. Pull Request를 생성하고, 전송을 하면 시간이 지나면 기존 프로젝트의 maintainer에게 review를 받고 수락을 하면 기존 branch에 나의 변경사항이 반영이 됩니다.

  1. 1467035957 2016.06.27 22:59

    잘 읽고 가여~

외부 저장소에서 Pulling

함께 개발하는 개발자가 있다면, 항상 최신의 상태를 받아와야 합니다. 예를 들어 A라는 작업을 하고 있지만, B에 의존성이 있다면, B작업의 최신 상태를 나의 저장소에서 최근 상태로 업데이트할 필요가 있습니다. 이때 외부 저장소에서의 변화를 나의 저장소로 반영하기 위해 하는 작업을 pull이라고 합니다. 


외부에 있는 저장소를 pull하기 위해서는 $ git pull <REMOTENAME> <BRANCHNAME> 명령어를 하면 됩니다. 

만약에 아무런 변화가 없으면 'Already up-to-date'라는 결과를 반환합니다. 변화가 있다면 나의 로컬 버전에 merge가 되어 변경이 됩니다.



Branch

  Git 저장소에서 branches를 사용하는 이유는 작업을 분리(isolate)하기 위해서 입니다. 우리가 최초에 생성하는 master 외에도 다른 branch를 생성이 가능합니다. 작업을 분리해서 작업을 한 뒤에 main branch에 merge를 하면 됩니다.


branch가 어떻게 동작하는지에 대해서 더 자세하게 알고싶으면 아래 사이트를 참고하시면 됩니다.
[참고] guides.github.com/overviews/flow

브랜치(Branch) 생성하기

git status 를 통해 현재 내가 어떤 branch에서 작업을 하는지 볼 수 있습니다.
git branch 을 통해 새로운 branch를 생성이 가능합니다.
git checkout 을 통해 브랜치를 이동할 수 있습니다.

새로운 파일 추가하기

  새롭게 만들어진 branch에서 새로운 파일을 추가하고, push하는 작업까지 해보겠습니다. add-.txt의 파일을 생성해 보겠습니다. git status를 치면, 새롭게 추가된 add-.txt가 보입니다. 파일을 git add .을 통해 추가를 하고, git commit -m "<COMMITMESSAGE>"를 통해 commit을 합니다. 마지막으로 이전 단계에서 생성한 브랜치에 push를 하면 됩니다. git push origin <BRANCHNAME>

Tips

브랜치를 생성하고, 생성한 브랜치로 변경하는 방법: $ git checkout -b

새로운 브랜치 생성하는 방법: $ git branch <BRANCHNAME>

브랜치 이동하는 방법: $ git checkout <BRANCHNAME>

브랜치 리스트 확인하기: $ git branch

브랜치 이름 변경하기: $ git branch -m <BRANCHNAME>

내가 작업하고 있는 브랜치 확인하기 $ git status


[참고] http://jlord.us/git-it/challenges/branches_arent_just_for_birds.html

Forks And Clones

Forks란?

  Open source projects에 참여하고 싶은가? 그렇다면 forks에 대해서 알아야 합니다. fork란 다른 원격 저장소에 있는 히스토리를 그대로 나의 github 원격 저장소에 복사하는 것을 말합니다. 다른 사람의 프로젝트에 바로 push를 할 수 없기 때문에 일단 나만의 프로젝트 버전을 관리하기 위해 다른 사람의 원격 저장소에서 프로젝트를 가져옵니다. 그런다음에 내가 contributing을 원래 원격 저장소로 요청을 합니다. 한마디로 외부 프로젝트를 진행할때 나만의 버전을 관리하기 위해서 fork를 해서 외부 프로젝트에 반영한다고 생각하시면 됩니다. fork를 했다면 나의 github에 있는 저장소에서 로컬로 clone을 합니다. 그럼이제 프로젝트 세팅 끝




외부 프로젝트, 나만의 원격 저장소에 복사하기

https://github.com/solidpple/patchwork 에 접속하셔서 오른쪽 상단에 있는 fork를 누르면 잠시후에 나의 github 저장소에 해당 프로젝트가 복사되는 것을 확인할 수 있습니다. 이 작업을 하기 전에 github에 로그인이 되어 있는 상태여야 합니다. 

원격 저장소에서 로컬 저장소로 가져오기

fork를 했다면 로컬에 있는 저장소로 해당 프로젝트를 가져온 뒤에 작업을 하시면 됩니다. 작업을 하기 위해 프로젝트를 clone할 위치로 이동을 한 뒤에

$ git clone 
$ cd patchwork

clone을 하고 나면 patchwork로 들어가면 프로젝트가 생성된 것을 확인할 수 있습니다. 이제 github의 저장소에 자동으로 연결이된 상태이고, 수정을 한 뒤에 앞서 배운 add, commit, push를 통해 반영을 하시면 됩니다.

기존 원격 저장소 연결하기

기존에 fork한 프로젝트의 변경되는 과정도 확인을 해야 하기 때문에, pull이 가능하도록 해아합니다. 그렇기 때문에 기존 fork한 원격 저장소도 추가를 합니다. https://github.com/jlord/patchwork 아래 git remote의 -v 옵션을 사용해 현재 연결되어 있는 git저장소를 확인 하실 수 있습니다. upstream은 remotename으로 종종 사용자들이 'upstream'으로 사용하기 때문에 사용했습니다. 이제는 pull을 하면 원래 저장소의 변경된 사항도 반영이 됩니다. 반영된 결과를 나의 수정 사항과 함께 나만의 원격 저장소에 반영을 하면 됩니다. 

$ git remote add upstream https://github.com/jlord/patchwork.git
$ git remote -v


[참고] http://jlord.us/git-it/challenges/forks_and_clones.html

  1. kbj0109 2018.01.28 20:07

    좋은 글 잘 봤습니다. 그런데 마지막의 upstream에관한 것을 보고 확인차 질문 드립니다.
    그럼 하나의 Local Branch가 하나 이상의 Remote Repository와 연결이 가능한건가요?
    그리고 가능하다면, Fork를 실행한 오리지널 Remote Repository (A)와 연결을 한 상태에서는 Pull을 하면,
    Fork로 생성한 새로운 저만의 Remote Remote Repository (B) 와 연동되어 A와 B의 변경사항이 제 Local Repository에 같이 적용 되는건가요?
    그러면 Push를 할 떄는 B인 제 Remote로만 반영이 되고, Pull을 할 떄는 A와 B로부터 둘 다 영향을 받는 건가요?

Remote Control

로컬(local)의 저장소(repository)를 원격(remote)저장소에 연결하고, 로컬 저장소에 변경된 내용을 원격 저장소에 반영(push)하는 방법에 대해서 설명을 하겠습니다.

원격(Remote)?

  로컬에서 혼자 커밋하면서 사용하면, 내 피시에만 나의 커밋(commit) 기록이 남습니다. 원격저장소에 로컬에 있는 프로젝트를 반영하기 위해 push를 합니다. push를 함으로써 원격저장소와 로컬저장소에 저장되어 있는 코드 및 기록이 일치(sync)가 됩니다. 이제 함께 프로젝트하는 사람들은 나의 프로젝트를 pulling(가져가기)하면, 프로젝트를 함께하는 모두에게 나의 로컬에 있는 프로젝트를 복사해서 자신의 프로젝트로 옮길 필요가 없습니다.

Create a remote repository

  • github.com를 접속해서 로그인을 합니다. 로그인을 하신후에 오른쪽 위에 + 버튼을 눌러서 새로운 저장소(Repository)를 생성합니다
  • 로컬에 있는 저장소와 이름을 동일하게 하고, 짧은 설명을 작성합니다.
  • 공개 범위는 public과 private이 있는데, public으로 하겠습니다. (나의 코드를 나만 볼것(private)이냐, 모두가 함께 공유할 것(public)이냐에 대한 설정)
  • README를 작성
  • gitignore, license는 'none'을 선택하시면 됩니다.(기본값)
  • 저장소를 생성합니다.

Readmes, .gitignores and licenses

  README, .gitignores, licenses파일은 open source projects에는 있어야 하는 파일입니다. 뭐 꼭 있어야 하는건 아닌데... contributor가 어떻게 해야하는지 가이드는 줘야하니까... 어지간하면 작성을 합니다. README는 프로젝트가 어떤 프로젝트인지, 어떻게 사용하는지, 어떻게 contribution을 하는지에 대해서 설명합니다. gitignore는 git이 nottrack을 해야하는 file의 리스트입니다. (패스워드가 있는 파일을 공유한다면...) license 파일은 나의 프로젝트에서 사용하는 라이센스 타입 리스트를 작성하는 파일입니다.
[참고] http://choosealicense.com/

생성한 저장소에 로컬을 연결하기

Github에 원격저장소를 만들었으면, 저장소의 주소를 로컬저장소에 http 또는 ssh를 통해 등록을 합니다.( 최초 생성한 프로젝트의 경로로 가서,

$ git remote add origin http://a/b/repo.git

을 하시면 로컬에 있는 repository라 remote가 어디인지 이제 알게 됩니다. 여기서 origin은 github's의 서버에 있는 이름이 됩니다.


Work를 Remote로 Push 하기

push를 통해 local에 있는 repository를 server로 전송이 가능합니다.

$ git push origin master

여기서 origin은 이전 단계에서 remote add origin으로 추가한 origin을 나타내고, master는 branch이름이고, 기본적으로 생성되는 branch 입니다.

Tips

Add remote connections
$ git remote add 

Set a URL to a remote
$ git remote set-url 

Pull in changes
$ git pull 

View remote connections
$ git remote -v Push changes $ git push

[참고] http://jlord.us/git-it/challenges/remote_control.html

Git설치, 설정하는 방법과 저장소(Repository) 생성, 파일 저장소에 추가 및 커밋(commit)하는 방법

들어가며

  Git은 Linus Torvalds라는 Linux operation system을 구현한 분이 처음에 코드 관리를 위해 만든 툴입니다. linux가 오픈소스인건 누구나 아실텐데요. 이처럼 오픈 소스를 개발하기 위해서는 한 명이 아닌 여러명이 개발을 해야합니다. 여러명이 한 프로젝트를 개발한다? 협업을 하는 측면에서 바라본다면, 정말 어려운 문제입니다. 내가 수정한 부분이 다른 사람의 수정한 부분과 동일하면 충돌이 일어날 것이고, 버전 별로 관리를 하지 않는다면 언제까지 .bak파일을 만들거나 복사 붙여넣기를 할 수 없는 문제입니다. 이 처럼 한 프로젝트를 여러명이 동시에 개발할때 생기는 문제를 해결해 주고, 코드 관리를 해주는게 git이라고 할 수 있습니다. git은 누구나 사용할 수 있는  오픈소스 소프트웨어 이고, programming 버전관리와 코드의 변화과정을 히스토리화 해서 볼수 있습니다.


Git 설치하기

  Git을 시작하기 위해서는 git을 설치를 해야합니다. 대표적인 사이트는 여러곳이 있는데, 그 중에서도 가장 대중적으로 사용하는 github에 대해 설명을 해 드리겠습니다. 거의 모든 git repository를 제공하는 사이트가 git을 기반으로 동작하기 때문에 비슷하니 github에 대한 사용법을 이해하시면 다른 git 관련 사이트를 이용해도 문제가 없습니다. 여기서 만약에 private하게 소수만 무료로 사용하고 싶다면 (https://bitbucket.org/)을 추천해 드리겠습니다. 

  다운로드 받는 경로는 아래와 같습니다. 한곳은 github이고, 다른 한 곳은 git을 받는 사이트 입니다.

  • https://desktop.github.com/
  • https://git-scm.com/downloads

Git 설정하기

  git을 다운로드 받았다면 command에서 git의 버전을 확인 할 수 있습니다. (설치 유무를 일단 확인합시다.) 아래 처럼 global하게 내가 사용할 username과 useremail을 설정 할 수 있습니다. 여기에는 github아이디를 쓰시면 됩니다. 나중에 수정이 가능하고, 추가적으로 여러 유저를 추가가 가능합니다. 
$ git --version 
$ git config --global user.name "username"
$ git config --global user.email "useremail"

저장소(Repository) 만들기

  저장소(Repository)는 프로젝트의 폴더라고 생각하시면 됩니다. 이 폴더에는 내가 변경한 파일의 정보, 코드 정보가 저장되어 있습니다. 

  저장소를 만드는 방법은 나의 프로젝트 ROOT_PATH에서 git init을 하면 됩니다. 아래 예제는 banana 라는 프로젝트를 ROOT_PATH로 하는 git repository를 생성한 내용입니다. git status를 하시면 내가 생성한 repository의 변화를 확인하실 수 있습니다. 지금은 아직 초기의 프로젝트이기 때문에 아무런 내용이 없습니다. commit에 대한 내용은 뒤에서 설명하겠습니다.

$ mkdir banana
$ cd banana
$ git  init
# Initialized empty Git repository in /home/ubuntu/workspace/banana/.git/
$ git status

새로운 파일을 만들기

  Repository에 새로운 파일을 추가해보겠습니다. 평소에 좋아하시는 Editor를 통해 파일을 생성해 보세요. 저는 banana라는 내용을 readme.txt에 담아 생성을 했습니다. 

$ echo "banana" > readme.txt

add, commit - Repository에 파일 추가 하기

  여기서 git add와 git commit에 대해서 간단하게 설명을 하면, git add는 working directory에서 staging area라고 보내는 명령이고, git commit은 staging area에 있는 파일을 repository로 넣는 역할을 합니다. 즉 내가 만든 파일을 repository에 넣기 위해서는 add와 commit을 모두 해줘야 합니다. 

  파일을 commit을 하기 전에 위에서 언급한 git status를 해보도록 하겠습니다.



$ git status

  내가 추가한 readme.txt가 빨간색 글씨로 보이는걸 확인할 수 있습니다. add되지 않은 파일의 목록을 보여줍니다. (여기서 폴더 내의 모든 파일을 추가하기 위해서는 add 뒤에 파라미터로 파일 이름 대신 .을 넘기면 됩니다.)

$ git add readme.txt

내가 추가를 하게 되면 new file : readme.txt를 확인하실 수 있습니다.

$ git commit -m "your commit message"

커밋을 한 뒤에 git status를 통해 확인해 보면 readme.txt의 내용이 commit된 것을 확인 할 수 있습니다.


파일 내용 변경하기



  readme.txt.파일을 변경을 해보고 저장해보겠습니다. 이렇게 저장을 한 뒤에

$ git status

modified: readme.txt라는빨간색으로 보여지는 내용을 확인할 수 있습니다. 현재 readme.txt가 수정이 됬다 라는 말입니다. 어떤 내용이 수정되었는지 확인을 하고 싶으면

$ git diff

를 하시면 변화된 내용을 확인하실 수 있습니다. -BBanana가 제거되고, +change banana가 추가 되었다는 내용을 확인할 수 있습니다.

$ git commit -m "change banana message"


commit을 다시 하게 되면, 변경상태가 add하고, commit을 하라고 합니다.

$ git add . 
$ git commit -m ""
$ git status

하시면 변경된 내용이 commit 되었음을 확인 할 수 있습니다.

Github 시작하기 및 ssh-key 등록하는 방법

들어가며

  Git은 코드 버전 관리를 해주는데 중요한 Software라고 할 수 있습니다. 우리가 흔히 학생때 조별 과제를 하게 되면 작은 프로젝트를 자주 진행하게 됩니다. 그 때 바로 등장한 멍청하지만 어떻게 보면 작은 프로젝트에 현명한... 방법중에 하나인 hand-merge 그냥 손머지죠. 이렇게 해왔는데, 프로젝트의 규모가 커지고, 기간이 길어지다 보면 자연스럽게 손머지는 한계에 부딪히게 됩니다. 저는 git을 코드관리도 중요하지만 공유하고 협업이라는 모두가 함께 만들어가는 opensource의 중요성에 대해서 더 중요하게 생각합니다. 소프트웨어 개발자라면 github 아이디 하나 정도는 갖고 있어야 하겠죠. 요즘에는 오픈소스 활동이나 stackoverflow 활동도 중요하기 때문에 없으면 가입을 합시다. 이번 포스팅은 Github 아이디에 SSH Key를 등록하는 방법에 대해서 설명해 드리겠습니다.   

1. ssh-key 생성하기 및 ssh-agent에 추가

  생성하기 전에 기존에 사용하시던 ssh-key가 있는 경우에는 바로 등록을 하시면 됩니다. 만약 없으시다면 생성하는 방법을 따라하시면 됩니다. 터미널에서 아래와 같은 명령어를 입력하고, 결과가 없다면 ssh key를 생성하셔야합니다. ssh-keygen을 하는 과정에서 중간에 나오는 질문에는 엔터로 넘기면 됩니다. (패스워드 설정 등등)

# ssh-key가 있는지 확인
ls -al ~/.ssh
# ssh-key 생성
ssh-keygen -t rss -b 4096 -C "your_email@example.com"

의 결과로 public/private rss key pair가 생성되고, ssh-agent에 추가를 해야 합니다.  ssh-agent를 백그라운드에서 시작한 후에 추가를 합니다.

eval "$(ssh-agent -s)"
ssh-add ~/.ssh/id_rsa

를 하시면 ssh-key 생성 및 ssh-agent에 추가가 완료 됩니다.


2. ssh-key 등록하기

  이제 생성된 ssh-key를 나의 github account에 추가하시면 됩니다. [Github 바로가기]

  사이트에서 로그인을 하게 되면 오른쪽위에 자신을 클릭하면 아래오 같은 화면에 보입니다. [Settings] --> [SSH and GPG keys] --> [New SSH key]를 클릭합니다. 그럼 아래와 같은 화면이 출력이 됩니다. 

클립 보드에 ~/.ssh/id_rsa.pub의 내용을 복사합니다. 아래 방법 중에 아무거나 사용하셔도 됩니다.  (만약 pbcopy가 없으면 ~/.ssh/id_rsa.pub의 경로에서 텍스트 에디터(vi)를 실행한 후에 복사 붙여넣기 하시면 됩니다.)

bcopy < ~/.ssh/id_rsa.pub
cat ~/.ssh/id_rsa.pub
vi ~/.ssh/id_rsa.pub

마지막으로 Add SSH key를 누르면 아래와 같은 화면이 나오면서 완료가 됩니다. 

여기까지 하시면 ssh key가 등록 되었습니다. 

[참고] https://help.github.com/articles/adding-a-new-ssh-key-to-your-github-account/

logfile.ParseFromString(f.read())하는 과정에서 오류가 발생했다. 

오류 내용은

DecodeError: Unexpected end-group tag.

Unexpected end-group tag.


gogole.external.protobuf/internal/decoder.py의 내용을 보면 아래와 같다.


def DecodeRepeatedField(buffer, pos, end, message, field_dict):
      value = field_dict.get(key)
      if value is None:
        value = field_dict.setdefault(key, new_default(message))
      while 1:
        value = field_dict.get(key)
        if value is None:
          value = field_dict.setdefault(key, new_default(message))
        # Read length.
        (size, pos) = local_DecodeVarint(buffer, pos)
        new_pos = pos + size
        if new_pos > end:
          raise _DecodeError('Truncated message.')
        # Read sub-message.
        if value.add()._InternalParse(buffer, pos, new_pos) != new_pos:
          # The only reason _InternalParse would return early is if it
          # encountered an end-group tag.
          raise _DecodeError('Unexpected end-group tag.')
        # Predict that the next tag is another copy of the same repeated field.
        pos = new_pos + tag_len
        if buffer[new_pos:pos] != tag_bytes or new_pos == end:
          # Prediction failed.  Return.
          return new_pos
    return DecodeRepeatedField



주석을 살펴보면 

The only reason _InternalParse would return early is if it encountered an end-group tag.

repeated에서 내부에 있는 end-group tag가 먼저 리턴이 되기 때문에 발생하는 예외라고 하는데 음...

이게 무슨말인지.


google/protobuf/internal/python_message.py

_InternalParse()의 내용을 확인해보면


def InternalParse(self, buffer, pos, end):
    self._Modified()
    field_dict = self._fields
    unknown_field_list = self._unknown_fields
    while pos != end:
      (tag_bytes, new_pos) = local_ReadTag(buffer, pos)
      field_decoder, field_desc = decoders_by_tag.get(tag_bytes, (None, None))
      if field_decoder is None:
        value_start_pos = new_pos
        new_pos = local_SkipField(buffer, new_pos, end, tag_bytes)
        if new_pos == -1: # HERE I HAVE -1 !!!
          return pos
        if not unknown_field_list:
          unknown_field_list = self._unknown_fields = []
        unknown_field_list.append((tag_bytes, buffer[value_start_pos:new_pos]))
        pos = new_pos
      else:
        pos = field_decoder(buffer, new_pos, end, self, field_dict)
        if field_desc:
          self._UpdateOneofState(field_desc)
    return pos
  cls._InternalParse = InternalParse


 


그렇다면.. 일단 임시 방편으로라도

exception을 처리할 수 밖에 없다. 


 try:
     logfile = LogDataProto.LogDataFile()
     logfile.ParseFromString(f.read())
except (Exception) as detail:
     print type(detail)
     print detail  


들어가며

  우리가 인터넷을 사용할때 주소를 보면 다 의미가 있다. 의미를 보고 생각하면 이 페이지를 코딩한 사람이 어떤식으로 값을 받고, 데이터는 어떻게 관리하는지 조금은 짐작이 가능하다. 아무 생각없이 주소를 보기보다는 의미를 생각하며 보면 더 좋을 것 같다. 또한 우리가 '도메인 네임을 신청한다.'라고할때 도메인네임이 URL의 구성에서 어디인지는 정확히 알아야 하지 않는가? 웹프로그래밍을 하다보면 아래 개념이 정확히 잡혀있지 않으면 404를 많이 보겠지요.


URL의 구성

http://www.example.com/folder/file.html#id

http:// 

www 

example.com

 /folder

/file.html 

#id 

 URL Schema

서버 

도메인 네임 

 폴더이름

 파일 이름

 Fragment 아이디

 

 호스트 네임 (IP 주소)

 리소스

 


URL Query 예제

http://..../resoure?name1='banana'&name2='hong'

 http://...

../resource 

?

name1='banana'

name2='hong' 

 URL Schema

 query

 name, value

 delimiter

 

 

 

 

 parameters[1]

 

 parameters[2]


+ Recent posts