API docs by Redocly

AmiNavi Backend API (1.0.0)

Download OpenAPI specification:

スマート編み物支援システム「あみナビ」のバックエンドAPI。
Firebase Authenticationによるユーザー認証、編み図データの管理を扱います。

ヘッダーから認証情報を取得してユーザー認証を行う

Firebae ID Token を Authorizationヘッダーから受け取り、ユーザー登録を行います。
ユーザーが既に存在する場合は、登録処理は行わず、既存のユーザー情報を返します。

Authorizations:
FirebaseAuth

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "display_name": "string",
  • "created_at": "2019-08-24T14:15:22Z"
}

ユーザーの情報を更新します

Authorizations:
FirebaseAuth
Request Body schema: application/json
display_name
string
profile_image_url
string

Responses

Request samples

Content type
application/json
{
  • "display_name": "string",
  • "profile_image_url": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "display_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z"
}

作品一覧を取得する(ユーザーごとにフィルタリング)

completedクエリパラメータでフィルタ可能
作品がないときは明示的にnullを返します

Authorizations:
FirebaseAuth
query Parameters
completed
boolean

完了状態によるフィルタ

Responses

Response samples

Content type
application/json
[
  • {
    }
]

新しい作品を登録する

Authorizations:
FirebaseAuth
Request Body schema: application/json
required
title
required
string
work_url
required
string
description
string

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "work_url": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "title": "string",
  • "work_url": "string",
  • "raw_index": 0,
  • "stitch_index": 0,
  • "is_completed": true,
  • "description": "string",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z"
}

特定の作品の詳細を取得します

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "title": "string",
  • "work_url": "string",
  • "raw_index": 0,
  • "stitch_index": 0,
  • "is_completed": true,
  • "description": "string",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z"
}

特定の作品の全情報を更新します

path Parameters
id
required
string
Request Body schema: application/json
required
title
required
string
work_url
required
string
raw_index
required
integer
stitch_index
required
integer
is_completed
required
boolean
description
required
string

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "work_url": "string",
  • "raw_index": 0,
  • "stitch_index": 0,
  • "is_completed": true,
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "title": "string",
  • "work_url": "string",
  • "raw_index": 0,
  • "stitch_index": 0,
  • "is_completed": true,
  • "description": "string",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z"
}

特定の作品のカウント・完了状態を更新します

path Parameters
id
required
string
Request Body schema: application/json
required
raw_index
integer
stitch_index
integer
is_completed
boolean

Responses

Request samples

Content type
application/json
{
  • "raw_index": 0,
  • "stitch_index": 0,
  • "is_completed": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "title": "string",
  • "work_url": "string",
  • "raw_index": 0,
  • "stitch_index": 0,
  • "is_completed": true,
  • "description": "string",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z"
}

特定の作品を削除します

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "error": "string"
}

画像URLから画像を取得し、csvへの変換を行います

Request Body schema: application/json
optional
image
string <byte>

Base64 エンコードされたバイト列

Responses

Request samples

Content type
application/json
{
  • "image": "string"
}

Response samples

Content type
application/json
{
  • "csv": "string",
  • "csv_url": "string"
}