WinCL

WinCL FAQ API

Faq Controller

GitHub OpenAPI

Documentation

📖
APIReference
https://api.wincl.io/v3/api-docs
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/wincl/refs/heads/main/authentication/wincl-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/wincl/refs/heads/main/openapi/wincl-faq-api-openapi.yml

Other Resources

🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/wincl/refs/heads/main/conventions/wincl-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/wincl/refs/heads/main/errors/wincl-error-codes.yml
🔗
Lifecycle
https://raw.githubusercontent.com/api-evangelist/wincl/refs/heads/main/lifecycle/wincl-lifecycle.yml
🔗
Conformance
https://raw.githubusercontent.com/api-evangelist/wincl/refs/heads/main/conformance/wincl-conformance.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/wincl/refs/heads/main/data-model/wincl-data-model.yml
🔗
AgenticAccess
https://raw.githubusercontent.com/api-evangelist/wincl/refs/heads/main/agentic-access/wincl-agentic-access.yml

OpenAPI Specification

wincl-faq-api-openapi.yml Raw ↑ 
openapi: 3.0.3
info:
  title: Wincl Admin FAQ API
  version: '1.0'
  description: Admin Controller
servers:
- url: https://api.wincl.io:443
  description: Inferred Url
tags:
- name: FAQ
  description: Faq Controller
paths:
  /api/v1/faq:
    get:
      tags:
      - FAQ
      summary: 자주찾는 질문 리스트
      operationId: faqListUsingGET
      parameters:
      - name: category
        in: query
        description: 카테고리
        required: false
        style: form
        schema:
          type: string
      - name: searchKeyword
        in: query
        description: 검색 키워드
        required: false
        style: form
        schema:
          type: string
      - name: pageSize
        in: query
        description: 페이지당 아이템 개수
        required: true
        style: form
        schema:
          type: integer
          format: int32
      - name: pageNum
        in: query
        description: 페이지 넘버
        required: true
        style: form
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WinclResponseDataList«Faq»'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      security:
      - Bearer 토큰 값:
        - global
  /api/v1/faq/category:
    get:
      tags:
      - FAQ
      summary: FAQ 카테고리 리스트
      operationId: getFaqCategoryUsingGET_1
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/WinclResponseData«List«FaqCategory»»'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      security:
      - Bearer 토큰 값:
        - global
  /api/v1/faq/{id}:
    get:
      tags:
      - FAQ
      summary: FAQ Detail
      operationId: getFaqUsingGET_1
      parameters:
      - name: id
        in: path
        description: GET `/faq` 응답의 seq 값
        required: true
        style: simple
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/WinclResponseData«Faq»'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      security:
      - Bearer 토큰 값:
        - global
components:
  schemas:
    WinclResponseData«List«FaqCategory»»:
      title: WinclResponseData«List«FaqCategory»»
      type: object
      properties:
        code:
          type: string
        data:
          type: array
          items:
            $ref: '#/components/schemas/FaqCategory'
        message:
          type: string
    Faq:
      title: Faq
      type: object
      properties:
        answerEn:
          type: string
          description: FAQ 답변 영어
        answerKr:
          type: string
          description: FAQ 답변 한글
        category:
          type: string
          description: FAQ 카테고리
        faqId:
          type: string
          description: FAQ ID
        questionEn:
          type: string
          description: FAQ 질문 영어
        questionKr:
          type: string
          description: FAQ 질문 한글
    WinclResponseDataList«Faq»:
      title: WinclResponseDataList«Faq»
      type: object
      properties:
        code:
          type: string
        currentPageNum:
          type: integer
          description: 현재 페이지 번호
          format: int32
        items:
          type: array
          items:
            $ref: '#/components/schemas/Faq'
        message:
          type: string
        pageSize:
          type: integer
          description: 페이지당 아이템 개수
          format: int32
        sortType:
          type: string
          description: 정렬 기준
          enum:
          - AMOUNT_ASC
          - AMOUNT_DESC
          - ASC
          - DESC
          - NONE
          - PRICE_ASC
          - PRICE_DESC
          - UNIT_PRICE_ASC
          - UNIT_PRICE_DESC
        totalCount:
          type: integer
          description: 전체 아이템 개수
          format: int32
        totalPages:
          type: integer
          description: 전체 페이지 수
          format: int32
    WinclResponseData«Faq»:
      title: WinclResponseData«Faq»
      type: object
      properties:
        code:
          type: string
        data:
          $ref: '#/components/schemas/Faq'
        message:
          type: string
    FaqCategory:
      title: FaqCategory
      type: object
      properties:
        cd:
          type: string
          description: FAQ 카테고리 코드
        nm_en:
          type: string
          description: FAQ 카테고리 영어 이름
        nm_kr:
          type: string
          description: FAQ 카테고리 한글 이름
        seq:
          type: integer
          description: FAQ 카테고리 순번
          format: int32
  securitySchemes:
    Bearer 토큰 값:
      type: http
      scheme: bearer
      bearerFormat: JWT