본문 바로가기

분류대기

swagger-editor 설치

[1. 개요]

swagger 란? 

  • 관련 설명을 작성하도록.

swagger-editor 는 swagger 파일을 좀 더 편하게 작성하기 위한 하나의 도구.


[2. 설치 개요]

기본적으로 docker image 를 제공함.

여기서는, 소스코드를 다운 받아 직접 설치하는 과정을 기술하도록 한다.

  • 먼저, node.js 가 설치되어 있어야 한다.
  • node.js 를 설치하면 npm 은 자동으로 설치 된다.
  • 현재 설치 된 버전은
    # node.js : 12.18.3
    # npm     :  6.14.6
  • Node.js >=20.3.0 and npm >=9.6.7 are the minimum required versions that this repo runs on

최신 버전 4.13.1 에서는 설치가 잘 안됨.

v4.9.2 에서는 되었음. (https://github.com/swagger-api/swagger-editor/releases/tag/v4.9.2)

 

설치 과정

  • 소스코드 다운로드
  • 압축 해제
  • npm start 
  • localhost:3001 으로 접속

[3. 주의 사항]

Swagger Editor works in the latest versions of Chrome, Safari, Firefox, and Edge.

  • whale 브라우저에서는 swagger-ui 가 화면에 나오지 않음..