openapi.yaml

openapi: 3.1.0
servers:
  - url: http://localhost:8080
    description: 開発環境
info:
  title: 基本情報編集API
  version: 1.0.0
  description: ユーザーの基本情報を編集するためのAPI
paths:
  /api/profile/basic-info:
    get:
      summary: 基本情報を取得する
      description: 現在登録されているユーザーの基本情報を返します。
      responses:
        '200':
          description: 取得成功
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasicInfo'
        '500':
          description: サーバーエラー
    put:
      summary: 基本情報を更新する
      description: 学籍番号や名前、自己紹介などの基本情報を編集します。
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BasicInfo'
      responses:
        '200':
          description: 更新成功
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateResponse'
        '400':
          description: バリデーションエラー
        '500':
          description: サーバーエラー

  /api/members:
    get:
      summary: メンバー一覧を取得する
      description: サークルメンバーのサマリ情報一覧を返します。
      responses:
        '200':
          description: 取得成功
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MemberSummary'
        '500':
          description: サーバーエラー
    post:
      summary: メンバーを登録する
      description: 新しいメンバーを登録します。
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MemberCreate'
      responses:
        '201':
          description: 登録成功
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MemberCreateResponse'
        '400':
          description: バリデーションエラー
        '500':
          description: サーバーエラー

  /api/members/{id}:
    get:
      summary: メンバー詳細を取得する
      description: 指定したメンバーの詳細情報を返します。
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: 取得成功
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MemberDetail'
        '404':
          description: メンバーが見つかりません
        '500':
          description: サーバーエラー

  /api/line-oauth:
    get:
      summary: LINE OAuthコールバック
      description: LINEのOAuthコールバックURLとして、付与されたcodeをアクセストークンに交換し、認証済みユーザー情報を返します。
      parameters:
        - name: code
          in: query
          required: true
          schema:
            type: string
          description: LINE OAuth認可コード
        - name: state
          in: query
          required: false
          schema:
            type: string
          description: CSRF対策のstate値
      responses:
        '200':
          description: アクセストークンとユーザー情報の取得に成功
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LineOAuthResponse'
        '400':
          description: 無効なcodeまたはstate
        '500':
          description: サーバーエラー
  

components:
  schemas:
    BasicInfo:
      type: object
      required:
        - student_id
        - faculty
        - last_name
        - first_name
        - nickname
        - self_introduction
        - visibility
      properties:
        student_id:
          type: string
          example: B1234567
        faculty:
          type: string
          example: 情報工学部
        last_name:
          type: string
          example: 田中
        first_name:
          type: string
          example: 太郎
        nickname:
          type: string
          example: たなたろ
        self_introduction:
          type: string
          description: Markdown形式の自己紹介文
          example: |
            # 自己紹介

            プログラミングが好きな2年生です！

            ## 興味のある分野
            - **Webアプリ開発**
            - **機械学習**
        visibility:
          $ref: '#/components/schemas/Visibility'
    Visibility:
      type: object
      required:
        - name
        - self_introduction
        - x
        - instagram
      properties:
        name:
          type: boolean
          example: false
        self_introduction:
          type: boolean
          example: true
        x:
          type: boolean
          example: false
        instagram:
          type: boolean
          example: true
    UpdateResponse:
      type: object
      properties:
        status:
          type: string
          example: success
        message:
          type: string
          example: 基本情報を更新しました。
    MemberSummary:
      type: object
      required:
        - id
        - name
        - nickname
        - roles
      properties:
        id:
          type: string
          example: "1"
        name:
          type: string
          example: "田中 太郎"
        nickname:
          type: string
          example: "たなたろ"
        roles:
          type: array
          items:
            type: string
          example: ["Web班", "副代表"]
        avatar:
          type: string
          example: "https://example.com/avatar.jpg"
    MemberDetail:
      allOf:
        - $ref: '#/components/schemas/MemberSummary'
        - type: object
          required:
            - department
            - year
            - bio
            - accounts
            - links
            - events
          properties:
            department:
              type: string
              example: "情報工学部"
            year:
              type: string
              example: "2年生"
            bio:
              type: string
              description: Markdown形式の自己紹介
              example: |
                # 自己紹介
                プログラミングが好きな2年生です！
            accounts:
              type: object
              required:
                - line
                - discord
                - github
              properties:
                line:
                  type: boolean
                  example: true
                discord:
                  type: boolean
                  example: true
                github:
                  type: boolean
                  example: true
            links:
              type: array
              items:
                type: object
                required:
                  - title
                  - url
                properties:
                  title:
                    type: string
                    example: "個人ブログ"
                  url:
                    type: string
                    example: "https://example.com"
            events:
              type: array
              items:
                type: object
                required:
                  - name
                  - date
                  - status
                properties:
                  name:
                    type: string
                    example: "新歓BBQ大会"
                  date:
                    type: string
                    format: date
                    example: "2024-04-15"
                  status:
                    type: string
                    enum: [upcoming, completed]
                    example: "upcoming"
    LineOAuthResponse:
      type: object
      required:
        - access_token
        - expires_in
        - user
      properties:
        access_token:
          type: string
          description: LINEから発行されたアクセストークン
          example: 5C2Yx...d9q
        refresh_token:
          type: string
          description: 必要に応じて返されるリフレッシュトークン
          example: 8Pd1...0Lm
        expires_in:
          type: integer
          description: アクセストークンの有効期限(秒)
          example: 2592000
        user:
          $ref: '#/components/schemas/LineUser'
    LineUser:
      type: object
      required:
        - user_id
        - display_name
      properties:
        user_id:
          type: string
          description: LINEユーザーID
          example: U123456789abcdef
        display_name:
          type: string
          description: 表示名
          example: 田中太郎
        picture_url:
          type: string
          format: uri
          description: プロフィール画像URL
          example: https://profile.line-scdn.net/abc123
        status_message:
          type: string
          description: ステータスメッセージ
          example: いつでも連絡ください
    MemberCreate:
      type: object
      required:
        - name
        - nickname
        - department
        - year
        - bio
        - roles
        - accounts
      properties:
        name:
          type: string
          example: "田中 太郎"
        nickname:
          type: string
          example: "たなたろ"
        department:
          type: string
          example: "情報工学部"
        year:
          type: string
          example: "2年生"
        bio:
          type: string
          description: Markdown形式の自己紹介
          example: "プログラミングが好きな2年生です！"
        roles:
          type: array
          items:
            type: string
          example: ["Web班", "副代表"]
        avatar:
          type: string
          example: "https://example.com/avatar.jpg"
        accounts:
          type: object
          required:
            - line
            - discord
            - github
          properties:
            line:
              type: boolean
              example: true
            discord:
              type: boolean
              example: true
            github:
              type: boolean
              example: false
        links:
          type: array
          items:
            type: object
            required:
              - title
              - url
            properties:
              title:
                type: string
                example: "個人ブログ"
              url:
                type: string
                example: "https://example.com"
    MemberCreateResponse:
      type: object
      required:
        - id
        - message
      properties:
        id:
          type: string
          description: 登録されたメンバーのID
          example: "abc123"
        message:
          type: string
          example: "メンバーを登録しました"