profile_go_server/openapi.yaml at master · Tsuboi-coder/profile_go_server · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
openapi: 3.0.0
servers:
  - url: http://localhost:8080
    description: 開発環境
info:
  title: 基本情報編集API
  version: 1.0.0
  description: ユーザーの基本情報を編集するためのAPI
paths:
  /api/profile/basic-info:
    put:
      summary: 基本情報を更新する
      description: 学籍番号や名前、自己紹介などの基本情報を編集します。
      requestBody:
        required: true
        content:
          application/json:
            schema:
              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:
                  type: object
                  properties:
                    name:
                      type: boolean
                      example: false
                    self_introduction:
                      type: boolean
                      example: true
                    x:
                      type: boolean
                      example: false
                    instagram:
                      type: boolean
                      example: true
      responses:
        '200':
          description: 更新成功
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: success
                  message:
                    type: string
                    example: 基本情報を更新しました。
        '400':
          description: バリデーションエラー
        '500':
          description: サーバーエラー