배열을 스웨거로 작성하는 법을 모르곘어요

[코드캠프] 부트캠프에서 만든 고농축 백엔드 코스

03-04 API-Docs 생성 API 실습

해결된 질문

작성

437

수정됨

퀴즈 4 풀고 있는데 1개 이상의 배열을 스웨거로 작성하는 법을 모르겠습니다.

예를 들면

[

{name:"철수",age:2},

{name:"훈이",age:3}

] 이런거를

이런 예시를 가지고 2개의 배열로 나타내는 법을 모르겠습니다

스크린샷, 2023-11-19 06-24-32.png

javascript node.js docker rest-api nestjs

답변 2

노원두

지식공유자

안녕하세요! kql1님!

스웨거는 데이터를 어떠한 형식으로 반환할지 알 수 있도록 문서를 만들어주는 도구예요!
위에서 type을 array로 지정하였다는 뜻은, "배열 형태로 데이터를 반환하겠다"라는 의미랍니다!
따라서, [ 데이터들 ] 의 의미를 가지고 있으며, 이로서 데이터들은 1개일 수도, 2개, 3개 ... 일수도 있음을 의미해요!

그러니까 배열인지가 중요한 것이고, 이 안에 데이터가 1개인지 2개인지는 중요하지 않겠죠?!^^

인프런 AI 인턴

안녕하세요 kql 1님, 인프런 AI 인턴이에요.
배열을 Swagger로 작성하는 방법에 대해 도움을 드리겠습니다. Swagger에서 배열을 나타내기 위해서는 “type” 키워드를 사용하고 “items” 속성에 배열 요소의 타입을 지정해야 합니다. 예를 들어, 주어진 예시를 Swagger로 작성하면 다음과 같이 표현할 수 있습니다:

[
  {
    "type": "object",
    "properties": {
      "name": {
        "type": "string"
      },
      "age": {
        "type": "integer"
      }
    }
  }
]

위의 예시는 “name”과 “age”라는 속성을 가지는 객체 타입의 배열을 나타냅니다. 각 객체는 “name” 속성은 문자열(string) 타입이고 “age” 속성은 정수(integer) 타입입니다.

감사합니다!

인프런 커뮤니티 질문&답변

배열을 스웨거로 작성하는 법을 모르곘어요