본문 바로가기

Back

[Swagger] OpenAPI3 설정 (yaml 다운로드 custom)

설정하지 않았을때 yaml 다운로드 기본 url

http://localhost:8080/v3/api-docs.yaml

 

 

 

local 설정

# swagger
springdoc:
  version: v1.0.0
  swagger-ui:
    path: /chat/swagger-ui.html #swagger ui로 접속하는 경로
#    config-url: /chat/api-docs/swagger-config  #config 경로 -> default : {api-docs.path}설정된 경로 +  '/swagger-config'
    url: /chat/api-docs.yaml  #swagger ui에서 연결되는 api document (json or yaml) -> default : {api-docs.path}설정된 경로 (json으로 보여짐)
    disable-swagger-default-url: true
  api-docs:
    path: /chat/api-docs  #api document가 저장될 경로. /chat/api-docs 하위에 저장.

 

alpha 설정

# swagger
springdoc:
  version: v1.0.0
  swagger-ui:
    path: /swagger-ui.html
    url: /chat/api-docs.yaml
    disable-swagger-default-url: true
  api-docs:
    path: /api-docs

 

** 알파서버에서는 도메인에서 `/chat`이 붙고, 

swagger ui에서 yaml을 다운로드 할때 내부에서는 `/chat`이 붙지않기때문에

swagger-ui.url에만 앞에 `/chat` 을 붙여줌