관리 메뉴

don't stop believing

Swagger의 yaml 파일 경로 변경 본문

Tools/Swagger

Swagger의 yaml 파일 경로 변경

Tongchun 2018. 1. 19. 19:23

Ubuntu 서버에 Swagger를 설치하고 swagger-ui를 연동한 상태입니다.

Swagger의 구성은 기본 구성에서 시작하겠습니다.

[Ubuntu에 Swagger 설치]


이제 API 서버 개발 진행에 따라 Swagger를 계속 업데이트 해줘야 하는데 서버에 있는 Swagger의 editor 실행이 안되 yaml 수정이 불편합니다. 혹시 내가 모르는 swagger edit 실행방법이 있는지는 모르겠으나 우선 생각한 방법은 아래와 같습니다.


  1. 사내 테스트 서버에 API 서버를 구성한다.
  2. Gitlab과 Jenkins로 사내 테스트 서버에 자동 배포을 구성한다.
  3. 사내 테스트 서버에 Swagger를 설치하고 실행한다.
  4. Local PC에 Swagger edit를 설치하고 yaml 파일을 작성한다.
  5. yaml 파일을 API 서버와 동일하게 배포한다.
  6. 사내 테스트 서버에 있는 Swagger는 배포되는 yaml을 참조한다.

이런 구성이라면 Swagger가 실행할때 yaml파일 경로를 내가 원하는 배포 경로로 맞춰줘야 합니다.

아래처럼 처리하면 됩니다.


먼저 원하는 위치에 yaml 파일을 복사해 놓습니다. 저는 우선 /home/macaron/에 yaml파일을 복사했습니다.

Swagger의 app.js파일에서 config에 swaggerFile을 추가합니다.

var config = {
  swaggerFile: '/home/macaron/swagger-test.yaml',	// path to my swagger.yaml
  appRoot: __dirname, // required config

};

그 다음 package.json 파일을 열고 scripts 오브젝트안에 edit을 추가합니다.

 {
"scripts": {
    "start": "node app.js",
    "test": "swagger project test",
    "edit": "swagger_swagger_fileName=/home/macaron/swagger-test.yaml swagger project edit"
  }
}

이제 Swagger를 다시 실행하면 원하는 경로에 있는 yaml파일을 읽게 됩니다.


재대로 적용되었는지 확인을 위해 기존 swagger.yaml파일이 아닌 /home/macaron/에 있는 swagger-test.yaml 파일을 수정하고 다시 swagger를 실행해 봅니다.


'Tools > Swagger' 카테고리의 다른 글

Visual Studio Code에서 swagger 보기  (0) 2018.06.18
Swagger의 yaml 파일 경로 변경  (0) 2018.01.19
swagger editor 설치 (on Mac)  (0) 2017.12.21
Ubuntu에 Swagger 설치  (0) 2017.12.20
0 Comments
댓글쓰기 폼