[Swagger] Swagger Editor 설치

Swagger Editor란

• Swaager는 OpenAPI를 정의하는 툴
  • OpenAPI (OpenAPI Specification - OAS) : RESTful API 규격에 맞게 API 스펙을 정의한 방식
  • Open API는 개방 API로 띄어쓰기의 차이지만 용어의 차이가 있다.
• Swagger Editor는 OpenAPI를 작성해 Swagger로 보여주기 위한 툴
  • 그 밖에도 Swaager UI, Swagger Codegen 등이 Swager의 도구로 사용된다.
  • https://editor.swagger.io/ 사이트에서 온라인으로 작성할 수도 있고,
  • 도커로 설치하여 로컬에서 작업할 수도 있다.

Docker 설치

docker pull swaggerapi/swagger-editor
docker run -d -p 80:8080 swaggerapi/swagger-editor

• M1 맥북인 경우
  • 'docker run -d -p 80:8080 swaggerapi/swagger-editor' 실행 시 다음과 같은 에러를 발생한다.

    WARNING: The requested image's platform (linux/amd64) does not match the detected host platform (linux/arm64/v8) and no specific platform was requested
    7f3d2e4c6773d8cd166d779eda7017bb10ef9c0d550d5f9bee72ba0ffa409f7b

• 해결 방법
  • docker ps에서 띄어진 컨테이너 확인
  • 컨테이너 삭제 docker rm containerName
  • linux/arm64 버전으로 다시 실행

    docker run --platform linux/amd64 -d -p 80:8080 swaggerapi/swagger-editor

브라우저에서 접속

• localhost or localhost:80

Docker로 띄운 Swagger Editor

 

쿠팡으로 연결 클릭

제주삼다수 그린 무라벨

파트너스 활동을 통해 일정액의 수수료를 제공받을 수 있음