Openapi 2 aspida로 멋진 정보를 만들고 싶을 때의 OpenAPI 기술 방법

954 단어 OpenAPItech
swagger-merger 등을 사용할 때
components:
  schemas:
    Note:
      type: object
      properties:
        id:
          type: integer
        user:
          $ref: './user.yml#User'
        body:
          type: string
...
처럼 쓰면 오픈api 제2 aspida 때 User가 펼쳐져서 예쁘지 않아요.
export type Note = {
  id: number
  user: {
    id: number
    status: number
    nickname: string
    email: string
    gender: number
    age: number
    created: string
  }
  body: string
}
그래서
components:
  schemas:
    Note:
      type: object
      properties:
        id:
          type: integer
        user:
          $ref: '#/components/schemas/User'
        body:
          type: string
...
이렇게 쓰는 것이 비교적 좋다.
export type Note = {
  id: number
  user: User
  body: string
}
우우, 시원하다.

좋은 웹페이지 즐겨찾기