sample_api4.md

FORMAT: 1A

Group ユーザAPI

ユーザ [/users/{id}]

ユーザの詳細 [GET]

処理概要

• ユーザを取得する

• Parameters

  • id: 1 (number, required) - ユーザID

• Response 200

  • Body

        {
          "name" : "John",
          "age" : 20,
          "admin" : true
        }
    

  • Schema

        {
          "type": "object",
          "properties": {
            "name": {
              "type": "string"
            },
            "age": {
              "type": "number"
            },
            "admin": {
              "type": "boolean"
            }
        }
    

ユーザの削除 [DELETE]

処理概要

• ユーザを削除する

• Paramaters

  • id: 1 (number, required) - ユーザID

• Response 200

ユーザ Collection [/users/]

ユーザ登録 [POST]

処理概要

• ユーザを登録する

• Request (application/json)

  • Attributes

    • name: John (string, required) 名前
    • age: 20 (number, required) 年齢
    • admin: true (boolean, required) 管理者かどうか

• Response 201 (application/json)

  • Headers

        Location: /users/1
    

  • Body

        {
          "name": "John",
          "age": 18,
          "admin": true
        }
    

  • Schema

        {
          "type" : "object",
          "properties" : {
              "id": {
                    "type" : "number"
              }
              "name": {
                    "type": "string"
              },
              "age": {
                    "type": "number"
              },
              "admin": {
                    "type": "boolean"
              }
          }
        }
    

ユーザ一覧 [GET]

• Response 200 (application/json)

  • Attributes (array[User])

Data Structures

User (object)

• id: 1 (number, required) ユーザID
• name: John (string, required) 名前
• age: 20 (number, required) 年齢
• admin: true (boolean, required) 管理者かどうか