[AI스쿨] yaml이란? yaml파일 작성법(swagger)
[AI스쿨] yaml이란? yaml파일 작성법(swagger) — #AI스쿨 #yaml #yaml파일작성법 #yamlswagger AI스쿨 msa기반 java 백엔드 코스 중에 공부한 내용을 작...
#AI스쿨 #yaml #yaml파일작성법 #yamlswagger
AI스쿨 msa기반 java 백엔드 코스 중에 공부한 내용을 작성하였습니다
학습법 이론
학습을 하기 이전, 명심해야할 학습법이 있다.
1.이해가지 않는다고 뒤돌아가 다시 보지 말 것
2.외우지 말라
=> 자주 봐서 외워짐을 당하라
=> 크롬을 통해 copy and paste하라
- 이해하는게 중요하다
=> 왜 생겨났는지?
=> 왜 사용하는지?
===> 응용이 가능해진다.
4.새로운 지식을 넣을땐 뇌를 비우자
yaml이란?
Yaml이란?
yaml이란 json과 xml처럼 데이터를 표현하는 방식입니다. 최근에 많이 사용하는 데이터 포맷으로 한눈에 구조를 알아보기 쉬운 장점이 있습니다.
데이터표현방식
가장 많이쓰는 json형태와 비교해서 yaml파일을 표현방식을 알아보겠습니다.
기본적으로 key-value형태로 표현합니다.
in yaml
| name: jworddescription: my name is jword |
|---|
in json
| { name: jword, description: my name is jword } |
|---|
들여쓰기
yaml은 들여쓰기로 계층구조를 지닙니다.
in yaml
| Server: name:jword server description: this server was created by jword |
|---|
in json
| server: { name: jword, description: my name is jword } |
|---|
배열
yaml은 -로 배열을 표현합니다. 여러개의 배열로 데이터를 표현하고 싶을때는 다음과 같이 표현합니다.
in yaml
| Server: - name:jword server description: this server was created by jword - name: jword server 2 description: this server was created by jword version --2 |
|---|
in json
| server:{ \[{name: jword,description: my name is jword }\], \[{name: jword server 2,description: this server was created by jword version --2}\]}//아마 이형태가 맞을껄요..? |
|---|
swagger를 접하면서 yaml을 처음 알게되었습니다. json과 형태가 달라 처음에는 많이 당황스러웠는데, 몇번 따라 쳐보면 익숙해집니다! 팁으로 들여쓰기를 잘 맞추시기 바랍니다. 들여쓰기가 틀리면 파일을 제대로 읽지 못합니다!
swagger yaml파일 분석하기
아래부터는swagger hub를 사용하면 나오는 yaml파일을 분석하여 정리했습니다. 처음보면 많이 어려움을 느낄 수 있는 내용이라, 처음 접하시는 분들에게 조금이라도 도움이 되었으면 좋겠습니다 :D
| #은 주석입니다!openapi : 3.0.0info: version: '1.0.0' #임의의 api버전입력 title: '뉴스 데이터' description: 'API에 대한 설명을 적어주세요'server:-description:"서버에 대한 설명을적어주세요" url: http:*//localhost:4000/api ** #서버 url입력해주세요. -description:"서버에 대한 설명을적어주세요" url: http://localhost:4001/api **#여러개도 ok!path: /: #데이터가 저장된 url을 입력하세요(URI) get: #get,post,put,delete방식으로 데이터를 요청할 수 있습니다 summary:"GET 방식에 대한 설명을 적어주세요" description: "서버에 아무 데이터 없이 GET방식으로 요청" tags: -GET 방식 response: '200': #응답시 반환되는 숫자 description: '서버에게 받은 결과값' content: application/json: #json파일로 받겠다는 표시 schema: type:object #json=object로 보시면됩니다!* properties: ok: type:boolean |
|---|
이정도면 swagger 작성법의 윤곽이 대략 잡히실거라 생각됩니다. 추후 yaml파일을 다루는날에 해당글을 업데이트 해보겠습니다.