simple-sns API (1.0.0)

Download OpenAPI specification:Download

Authentication

Bearer

このAPIはBearerトークンを使って認証します

Security Scheme Type	HTTP
HTTP Authorization Scheme	bearer

auth

signIn

Request Body schema: application/json

email required	string
password required	string

Responses

Request samples

Payload

Content type

application/json

{"email": "string",
"password": "string"
}

Response samples

200
400

Content type

application/json

{"user": {"id": 0,
"name": "string",
"email": "string",
"iconImageUrl": "string"
},
"token": "string"
}

account

getAccount

Authorizations:

Bearer

Responses

Response samples

200

Content type

application/json

{"user": {"id": 0,
"name": "string",
"email": "string",
"iconImageUrl": "string"
}
}

createAccount

Request Body schema: application/json

name required	string
email required	string
password required	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"email": "string",
"password": "string"
}

Response samples

200

Content type

application/json

{"user": {"id": 0,
"name": "string",
"email": "string",
"iconImageUrl": "string"
},
"token": "string"
}

updateIconImage

Authorizations:

Bearer

Request Body schema: multipart/form-data

file

required

string <binary>

ただのstringではなくFileなどをアップロードする必要があるので注意

Responses

Response samples

200

Content type

application/json

{"user": {"id": 0,
"name": "string",
"email": "string",
"iconImageUrl": "string"
}
}

updateProfile

Authorizations:

Bearer

Request Body schema: application/json

name required	string
email required	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"email": "string"
}

Response samples

200

Content type

application/json

{"user": {"id": 0,
"name": "string",
"email": "string",
"iconImageUrl": "string"
}
}

post

findPostList

Authorizations:

Bearer

query Parameters

	object (pagination) 最新のデータをn件取得したい場合、cursorは指定せず、sizeにnを入れる。idがm以降のデータをn件取得したい場合、cursorにm、sizeにnを入れる。
	object (RequestPostFilter)

Responses

Response samples

200

Content type

application/json

{"posts": [{"id": 0,
"body": "string",
"userId": 0,
"createdAt": "2019-08-24T14:15:22Z",
"user": {"id": 0,
"name": "string",
"iconImageUrl": "string"
}
}
]
}

createPost

Authorizations:

Bearer

Request Body schema: application/json

required

object

Responses

Request samples

Payload

Content type

application/json

{"post": {"body": "string"
}
}

Response samples

200

Content type

application/json

{"post": {"id": 0,
"body": "string",
"userId": 0,
"createdAt": "2019-08-24T14:15:22Z",
"user": {"id": 0,
"name": "string",
"iconImageUrl": "string"
}
}
}

findPost

Authorizations:

Bearer

path Parameters

id

required

number

Responses

Response samples

200

Content type

application/json

{"post": {"id": 0,
"body": "string",
"userId": 0,
"createdAt": "2019-08-24T14:15:22Z",
"user": {"id": 0,
"name": "string",
"iconImageUrl": "string"
}
}
}

deletePost

Authorizations:

Bearer

path Parameters

id

required

number

Responses

Response samples

200

Content type

application/json

{"success": true
}

room

findRoomList

Authorizations:

Bearer

Responses

Response samples

200

Content type

application/json

{"rooms": [{"id": "string",
"messages": [{"id": 0,
"content": "string",
"userId": 0,
"roomId": "string",
"postId": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"user": {"id": 0,
"name": "string",
"iconImageUrl": "string"
},
"post": {"id": 0,
"body": "string",
"userId": 0,
"createdAt": "2019-08-24T14:15:22Z",
"user": {"id": 0,
"name": "string",
"iconImageUrl": "string"
}
}
}
],
"roomUsers": [{"roomId": "string",
"userId": 0,
"user": {"id": 0,
"name": "string",
"iconImageUrl": "string"
}
}
]
}
]
}

findOrCreateRoom

Authorizations:

Bearer

Request Body schema: application/json

userIds

required

Array of integers[ items ]

Responses

Request samples

Payload

Content type

application/json

{"userIds": [0
]
}

Response samples

200

Content type

application/json

{"room": {"id": "string",
"messages": [{"id": 0,
"content": "string",
"userId": 0,
"roomId": "string",
"postId": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"user": {"id": 0,
"name": "string",
"iconImageUrl": "string"
},
"post": {"id": 0,
"body": "string",
"userId": 0,
"createdAt": "2019-08-24T14:15:22Z",
"user": {"id": 0,
"name": "string",
"iconImageUrl": "string"
}
}
}
],
"roomUsers": [{"roomId": "string",
"userId": 0,
"user": {"id": 0,
"name": "string",
"iconImageUrl": "string"
}
}
]
}
}

findRoom

Authorizations:

Bearer

path Parameters

id

required

string

Responses

Response samples

200

Content type

application/json

{"room": {"id": "string",
"messages": [{"id": 0,
"content": "string",
"userId": 0,
"roomId": "string",
"postId": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"user": {"id": 0,
"name": "string",
"iconImageUrl": "string"
},
"post": {"id": 0,
"body": "string",
"userId": 0,
"createdAt": "2019-08-24T14:15:22Z",
"user": {"id": 0,
"name": "string",
"iconImageUrl": "string"
}
}
}
],
"roomUsers": [{"roomId": "string",
"userId": 0,
"user": {"id": 0,
"name": "string",
"iconImageUrl": "string"
}
}
]
}
}

messages

listMessages

Authorizations:

Bearer

query Parameters

	object (pagination) 最新のデータをn件取得したい場合、cursorは指定せず、sizeにnを入れる。idがm以降のデータをn件取得したい場合、cursorにm、sizeにnを入れる。
roomId required	string

Responses

Response samples

200

Content type

application/json

{"messages": [{"id": 0,
"content": "string",
"userId": 0,
"roomId": "string",
"postId": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"user": {"id": 0,
"name": "string",
"iconImageUrl": "string"
},
"post": {"id": 0,
"body": "string",
"userId": 0,
"createdAt": "2019-08-24T14:15:22Z",
"user": {"id": 0,
"name": "string",
"iconImageUrl": "string"
}
}
}
]
}

message

createMessage

Authorizations:

Bearer

Request Body schema: application/json

content required	string
roomId required	string

Responses

Request samples

Payload

Content type

application/json

{"content": "string",
"roomId": "string"
}

Response samples

200

Content type

application/json

{"message": {"id": 0,
"content": "string",
"userId": 0,
"roomId": "string",
"postId": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"user": {"id": 0,
"name": "string",
"iconImageUrl": "string"
},
"post": {"id": 0,
"body": "string",
"userId": 0,
"createdAt": "2019-08-24T14:15:22Z",
"user": {"id": 0,
"name": "string",
"iconImageUrl": "string"
}
}
}
}

createMessageViaPost

Authorizations:

Bearer

Request Body schema: application/json

content required	string
postId required	integer

Responses

Request samples

Payload

Content type

application/json

{"content": "string",
"postId": 0
}

Response samples

200

Content type

application/json

{"message": {"id": 0,
"content": "string",
"userId": 0,
"roomId": "string",
"postId": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"user": {"id": 0,
"name": "string",
"iconImageUrl": "string"
},
"post": {"id": 0,
"body": "string",
"userId": 0,
"createdAt": "2019-08-24T14:15:22Z",
"user": {"id": 0,
"name": "string",
"iconImageUrl": "string"
}
}
}
}