[Swagger-Git/CI CD] Swagger Hub - bitbucket sync connect

 

오늘은 Swagger-Hub의 API가 hub에 관리가 되지만, 왠지 모를 불안감으로 API (YAML, JSON)를 bitbucket에 연결시켜

자동 소스 저장을 해보려고 합니다.  개발자라 함은 개발한 내역도 자동 저장하면서 배포까지 쉽게 하는게 개발자죠~ ㅋ

 

swagger는 개인적으로 써보면 써볼수도 Rest UI도 보기좋고, 포팅도 잘되고 여러모로 참 좋은 어플리케이션 같습니다.

swagger의 여러 가지 다른 기능은 추후 블로그에 개시하도록 할게요~ ㅋㅋ

잡담은 이제 그만하고 본론으로~ ㅋㅋ 연동 해볼게요~

 

아래의 가이드에서 사진에 빨간색은 개인정보로 가린거니 참고해서 봐주세요~

---

 

1. Swagger API와 연동할 bitbucket repository 생성

레포지터리 생성 화면

- 개인적으로 사용하시는 bitbucket에 repository 하나 생성 해주세요~

 

2. Swagger-Hub에서 접속하여 연동할 API 프로젝트 선택

 

 

3.  Swagger - 프로젝트 제목을 누르고 밑에 하단의 "Integrations"을 클릭

integration

- 연동하고자 하는 프로젝트를 생성

 

 

 

4. Swagger - integration : Bitbucket Cloud Sync를 클릭

- Bitbucket Cloud와 연동하기 위함으로 해당 카테고리를 클릭합니다. (git hub과 연동하고 싶으신 분은 GItHub Sync클릭)

 

 

5. Swagger - integration 작성

- Name : integrations의 이름으로 원하는 이름을 작성하면 된다. 필자는 XML 데이터 연동이므로, XML-API로 제목을 지었다.

 

- Bitbucket Token : 해당 토큰은 bitbucket과의 연동을 위한 인증 토큰 교환입니다. 클릭하면 자동 창이 발생하고, bitbucket 아이디 / 패스워크 입력 시 토큰 설정이 됩니다. 

- Repository Owner : 레포지터리 소유주 (저는 필자가 소유주입니다.)

- Repository : Swagger.json 데이터를 저장할 레포지터리를 선정합니다. (이는 1번 과정에서 생성한 레포지터리를 넣으면 됩니다.)

 

- Generated API Code : 저장한 generated API code를 선택합니다. ( Client SDK, Server Stub 등 여러가지가 있지만 필자는 json이 필요하므로 json을 선택하였습니다. )

- Output Folder : node-output (자동 입력됩니다.)

- Output file :  generated API code가 어떤 파일로 저장 할지 입력하면 됩니다. (저는 디폴트)

 

6. Swagger - integration 완료 (실행 스타트)

- 혹시 아래와 같이 에러가 발생한다면 1번에서 생성항 bitbucket repo의 최초 커밋이 없어서 발생하는 에러입니다.

the 'bitbucket cloud sync' plugin failed with the following error: failed to synchronize the [API] object--unable to read from repository 'https://bitbucket.org/[API]'. please ensure that you have the correct permissions. if this is a new repository, please ensure that at least one branch exists in the remote origin by committing at least one file. ensure your bitbucket credentials have full access to the 'repo' scope

- 최초 커밋 후 push하면 그다음에는 연동이 될겁니다.

 

7. 연동 저장 후 화면

- bitbucket에서 소스 저장 유무 확인 (오우 뿌듯하군..)

repository 대시보드

내부 저장된 화면

 

 

후.. 오늘 Swagger-bitbucket Cloud 연동하는 과정을 보았다.

먼가 소스가 안전해지는 희열이 느껴진다. ㅋㅋ 

 

서버 개발자라면 언제나 소스는 잘 관리해야지요 후후~

 

모두들 오늘도 화이팅입니다.