swagger 긴 주석 작성 방법 (yaml파일) 줄 바꿈, 글씨 강조

swagger 작성 시  설명 해야하는게 많을 경우 주석이 길어지는데 이는 주석의 가독성이 떨어진다. 

그래서 강조, 한 줄 내리기 등 표시를 해가며 나타내어야 한다.

 

yaml파일을 사용했다.

 

description 에서 수정한다.

description 에서 | 가 중요하다. 꼭 있어야 하니 기억하자. 

 

1. 줄 바꿈 

문장이 끝나고 공백 두번을 넣으면 줄 바꿈이 된다.

description: |
  Pet Store APIs
  This is a sample Petstore server  
  Contains API Note: to manage the pet store

줄 바꿈

2. 글씨 강조, 기울임꼴 하기

** , __ 로 묶으면 해당하는 글씨가 강조가 된다.

 _ 로 묶으면 기울임꼴이 된다.

 description: | 
        **Pet** Store APIs  
        __This is a sample Petstore server__    
        Contains API _Note: to manage the pet store_

글씨 변경

가장 많이 사용하는 것만 정리 했다 나중에 사용하면 더 추가 할 예정이다.

 

출처 : https://www.baeldung.com/swagger-format-descriptions