Skip to content

Latest commit

 

History

History
1357 lines (1198 loc) · 26.2 KB

api-specification-v0.1.0.md

File metadata and controls

1357 lines (1198 loc) · 26.2 KB
Raw

API Specification

Category Desc Method Endpoint
🧔 User Sign Up POST /api/user/signUp
🧔 User Sign In POST /api/user/signIn
🧔 User Get My UserInfo GET /api/user
🏛 Square Get All Reviews GET /api/square/reviews
🏛 Square Get All Quotes GET /api/square/quotes
📂 Space Get a Space GET /api/space/[spaceId]
📂 Space Modify a Space PATCH /api/space/[spaceId]
📂 Space Get a Book in the Space GET /api/space/[spaceId]/book/[bookId]
📂 Space Add a Book to My space POST /api/space/[spaceId]/book
📂 Space Delete a Book from My space DELETE /api/space/[spaceId]/book/[bookId]
📂 Space Create a Review POST /api/space/[spaceId]/book/[bookId]/review
📂 Space Modify a Review PATCH /api/space/[spaceId]/book/[bookId]/review/[reviewId]
📂 Space Delete a Review DELETE /api/space/[spaceId]/book/[bookId]/review/[reviewId]
📂 Space Get all Review Comments in a Review GET /api/space/[spaceId]/book/[bookId]/review/[reviewId]/comment
📂 Space Create a Review Comment POST /api/space/[spaceId]/book/[bookId]/review/[reviewId]/comment
📂 Space Modify a Review Comment PATCH /api/space/[spaceId]/book/[bookId]/review/[reviewId]/comment/[commentId]
📂 Space Delete a Review Comment DELETE /api/space/[spaceId]/book/[bookId]/review/[reviewId]/comment/[commentId]
📂 Space Create a Quote POST /api/space/[spaceId]/book/[bookId]/quote
📂 Space Modify a Quote PATCH /api/space/[spaceId]/book/[bookId]/quote/[quoteId]
📂 Space Delete a Quote DELETE /api/space/[spaceId]/book/[bookId]/quote/[quoteId]
📂 Space Get all Quote Comments in a Quote GET /api/space/[spaceId]/book/[bookId]/quote/[quoteId]/comment
📂 Space Create a Quote Comment POST /api/space/[spaceId]/book/[bookId]/quote/[quoteId]/comment
📂 Space Modify a Quote Comment PATCH /api/space/[spaceId]/book/[bookId]/quote/[quoteId]/comment/[commentId]
📂 Space Delete a Quote Comment DELETE /api/space/[spaceId]/book/[bookId]/quote/[quoteId]/comment/[commentId]
💒 Salon Add a Salon GET /api/salon
💒 Salon Get a Salon GET /api/salon/[salonId]
💒 Salon Modify a Salon PATCH /api/salon/[salonId]
💒 Salon Delete a Salon DELETE /api/salon/[salonId]
💒 Salon Get a Book in the Salon GET /api/salon/[salonId]/book/[bookId]
💒 Salon Add a Book to the Salon POST /api/salon/[salonId]/book
💒 Salon Delete a Book from Salon DELETE /api/salon/[salonId]/book/[bookId]
💒 Salon Create a Review POST /api/salon/[salonId]/book/[bookId]/review
💒 Salon Modify a Review PATCH /api/salon/[salonId]/book/[bookId]/review/[reviewId]
💒 Salon Delete a Review DELETE /api/salon/[salonId]/book/[bookId]/review/[reviewId]
💒 Salon Get all Review Comments in a Review GET /api/salon/[salonId]/book/[bookId]/review/[reviewId]/comment
💒 Salon Create a Review Comment POST /api/salon/[salonId]/book/[bookId]/review/[reviewId]/comment
💒 Salon Modify a Review Comment PATCH /api/salon/[salonId]/book/[bookId]/review/[reviewId]/comment/[commentId]
💒 Salon Delete a Review Comment DELETE /api/salon/[salonId]/book/[bookId]/review/[reviewId]/comment/[commentId]
💒 Salon Create a Quote POST /api/salon/[salonId]/book/[bookId]/quote
💒 Salon Modify a Quote PATCH /api/salon/[salonId]/book/[bookId]/quote/[quoteId]
💒 Salon Delete a Quote DELETE /api/salon/[salonId]/book/[bookId]/quote/[quoteId]
💒 Salon Get all Quote Comments in a Quote GET /api/salon/[salonId]/book/[bookId]/quote/[quoteId]/comment
💒 Salon Create a Quote Comment POST /api/salon/[salonId]/book/[bookId]/quote/[quoteId]/comment
💒 Salon Modify a Quote Comment PATCH /api/salon/[salonId]/book/[bookId]/quote/[quoteId]/comment/[commentId]
💒 Salon Delete a Quote Comment DELETE /api/salon/[salonId]/book/[bookId]/quote/[quoteId]/comment/[commentId]

User - Sign Up

Method & Endpoint

POST /api/user/signUp

Parameters

*In : header, path, query, body

Name Type In Description
loginId string body login id
password string body password
nickname string body nickname

Default Response

Status: 201 Created

34 (User Id)

Conflict

Status: 409 Conflict

{
    "message": "ID already exists"
}

User - Sign In

Method & Endpoint

GET /api/user/signIn

Parameters

Name Type In Description
loginId string body login id
password string body password

Default Response

Status: 200 OK

{
    "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJsb2dpbklkIjoibXlJZDUzMTU0MjU1IiwiaWF0IjoxNjE1NzA5MzcwfQ.mI_3WXnutL39Z8im68Kx6Rhi0AYMi-atEEO_yv1VJZw"
}

Unauthorized

Status: 401 Unauthorized

Unauthorized

User - Get My UserInfo

Method & Endpoint

GET /api/user

Parameters

Name Type In Description
Authorization string header accessToken

Default Response

Status: 200 OK

{
    "id": 35,
    "loginId": "myId",
    "nickname": "myNickname",
    "iat": 1615867236
}

Square - Get All Reviews

Method & Endpoint

GET /api/square/reviews

Parameters

Name Type In Description
- - - -

Default Response

Status: 200 OK

{
    {
        "id": 1,
        "title": "asdf",
        "content": "22131",
        "reviewer": "Granzort",
        "created_at": "2019-12-31T15:00:00.000Z",
        "updated_at": "2019-12-31T15:00:00.000Z",
        "book_title": "차라투스트라는 이렇게 말했다",
        "book_author": "니체",
        "salon": "G salon",
        "space": null
    },
}

Square - Get All Quotes

Method & Endpoint

GET /api/square/quotes

Parameters

Name Type In Description
- - - -

Default Response

Status: 200 OK

[
    {
        "id": 1,
        "content": "32",
        "page": 123,
        "quoter": "Granzort",
        "created_at": "2019-12-31T15:00:00.000Z",
        "updated_at": "2019-12-31T15:00:00.000Z",
        "book_title": "차라투스트라는 이렇게 말했다",
        "book_author": "니체",
        "salon": "G salon",
        "space": null
    },
]

Space - Get a Space

Method & Endpoint

GET /api/space/[spaceId]

Parameters

Name Type In Description
spaceId string path space id

Default Response

Status: 200 OK

{
    "id": 3,
    "name": "my space",
    "owner_id": 35,
    "owner_nickname": "myNickname",
    "books": [
        {
            "id": 12,
            "title": "bookkkkk",
            "author": "mememem",
            "description": "anananan"
        }
    ]
}

Space - Modify a Space

Method & Endpoint

PATCH /api/space/[spaceId]

Parameters

Name Type In Description
spaceId string path space id
name string body new space name

Default Response

Status: 200 OK

{
    "message": "modified successfully"
}

Space - Get a Book in the Space

Method & Endpoint

GET /api/space/[spaceId]/book/[bookId]

Parameters

Name Type In Description
spaceId string path space id
bookId string path book id

Default Response

Status: 200 OK

{
    "id": 12,
    "title": "bookkkkk",
    "author": "mememem",
    "description": "anananan",
    "reviews": [
        {
            "id": 8,
            "title": "adsfaf",
            "content": "ddddd",
            "reviewer": "myNickname",
            "created_at": "2021-03-16T05:19:51.000Z",
            "updated_at": "2021-03-16T05:19:51.000Z",
            "book_title": "bookkkkk",
            "book_author": "mememem",
            "salon": null,
            "space": "update"
        },
    ],
    "quotes": [
        {
            "id": 6,
            "content": "myquotes",
            "page": 213,
            "quoter": "myNickname",
            "created_at": "2021-03-16T08:15:30.000Z",
            "updated_at": "2021-03-16T08:15:30.000Z",
            "book_title": "bookkkkk",
            "book_author": "mememem",
            "salon": null,
            "space": "update"
        },
    ]
}

Space - Add a Book to My Space

Method & Endpoint

POST /api/space/[spaceId]/book

Parameters

Name Type In Description
spaceId string path space id
title string body book title
author string body book author
description string body book description

Default Response

Status: 201 Created

365 (Book Id)

Space - Delete a Book from My Space

Method & Endpoint

DELETE /api/space/[spaceId]/book/[bookId]

Parameters

Name Type In Description
spaceId string path space id
bookId string path book id

Default Response

Status: 200 OK

{ 
    "message": "deleted successfully"
}

Nothing to Delete

Status: 200 OK

{
    "messgage": "no items to delete"
}

Space - Create a Review

Method & Endpoint

POST /api/space/[spaceId]/book/[bookId]/review

Parameters

Name Type In Description
spaceId string path space id
bookId string path book id
title string body review title
content string body review content

Default Response

Status: 201 Created

36 (Review Id)

Space - Modify a Review

Method & Endpoint

PATCH /api/space/[spaceId]/book/[bookId]/review/[reviewId]

Parameters

Name Type In Description
spaceId string path space id
bookId string path book id
reviewId string path review id
title string body new review title
content string body new review content

Default Response

Status: 200 OK

{
    "message": "modified successfully"
}

Space - Delete a Review

Method & Endpoint

DELETE /api/space/[spaceId]/book/[bookId]/review/[reviewId]

Parameters

Name Type In Description
spaceId string path space id
bookId string path book id
reviewId string path review id

Default Response

Status: 200 OK

{
    "message": "deleted successfully"
}

Nothing to Delete

Status: 200 OK

{
    "messgage": "no items to delete"
}

Space - Get all Review Comments in a Review

Method & Endpoint

GET /api/space/[spaceId]/book/[bookId]/review/[reviewId]/comment

Parameters

Name Type In Description
spaceId string path space id
bookId string path book id
reviewId string path review id

Default Response

Status: 200 OK

[
    {
        "id": 5,
        "comment": "ASDFASDF",
        "created_at": "2019-12-31T15:00:00.000Z",
        "updated_at": "2019-12-31T15:00:00.000Z",
        "commenter": "myNickname"
    }
]

Space - Create a Review Comment

Method & Endpoint

POST /api/space/[spaceId]/book/[bookId]/review/[reviewId]/comment

Parameters

Name Type In Description
spaceId string path space id
bookId string path book id
comment string body review comment

Default Response

Status: 201 Created

36 (Review Comment Id)

Space - Modify a Review Comment

Method & Endpoint

PATCH /api/space/[spaceId]/book/[bookId]/review/[reviewId]/comment/[commentId]

Parameters

Name Type In Description
spaceId string path space id
bookId string path book id
reviewId string path review id
commentId string path comment id
comment string body review comment

Default Response

Status: 200 OK

{
    "message": "modified successfully"
}

Space - Delete a Review Comment

Method & Endpoint

DELETE /api/space/[spaceId]/book/[bookId]/review/[reviewId]/comment/[commentId]

Parameters

Name Type In Description
spaceId string path space id
bookId string path book id
reviewId string path review id
commentId string path comment id

Default Response

Status: 200 OK

{
    "message": "deleted successfully"
}

Nothing to Delete

Status: 200 OK

{
    "messgage": "no items to delete"
}

Space - Create a Quote

Method & Endpoint

POST /api/space/[spaceId]/book/[bookId]/quote

Parameters

Name Type In Description
spaceId string path space id
bookId string path book id
content string body quote content
page string body quote page

Default Response

Status: 201 Created

36 (quote Id)

Space - Modify a Quote

Method & Endpoint

PATCH /api/space/[spaceId]/book/[bookId]/quote/[quoteId]

Parameters

Name Type In Description
spaceId string path space id
bookId string path book id
quoteId string path quote id
content string body new quote content
page string body new quote page

Default Response

Status: 200 OK

{
    "message": "modified successfully"
}

Space - Delete a Quote

Method & Endpoint

DELETE /api/space/[spaceId]/book/[bookId]/quote/[quoteId]

Parameters

Name Type In Description
spaceId string path space id
bookId string path book id
quoteId string path quote id

Default Response

Status: 200 OK

{
    "message": "deleted successfully"
}

Nothing to Delete

Status: 200 OK

{
    "messgage": "no items to delete"
}

Space - Get all quote Comments in a Quote

Method & Endpoint

GET /api/space/[spaceId]/book/[bookId]/quote/[quoteId]/comment

Parameters

Name Type In Description
spaceId string path space id
bookId string path book id
quoteId string path quote id

Default Response

Status: 200 OK

[
    {
        "id": 5,
        "comment": "mycommmmment for quote",
        "created_at": "2021-03-16T08:17:01.000Z",
        "updated_at": "2021-03-16T08:17:01.000Z",
        "commenter": "myNickname"
    },
]

Space - Create a Quote Comment

Method & Endpoint

POST /api/space/[spaceId]/book/[bookId]/quote/[quoteId]/comment

Parameters

Name Type In Description
spaceId string path space id
bookId string path book id
comment string body quote comment

Default Response

Status: 201 Created

36 (quote Comment Id)

Space - Modify a Quote Comment

Method & Endpoint

PATCH /api/space/[spaceId]/book/[bookId]/quote/[quoteId]/comment/[commentId]

Parameters

Name Type In Description
spaceId string path space id
bookId string path book id
quoteId string path quote id
commentId string path comment id
comment string body quote comment

Default Response

Status: 200 OK

{
    "message": "modified successfully"
}

Space - Delete a Quote Comment

Method & Endpoint

DELETE /api/space/[spaceId]/book/[bookId]/quote/[quoteId]/comment/[commentId]

Parameters

Name Type In Description
spaceId string path space id
bookId string path book id
quoteId string path quote id
commentId string path comment id

Default Response

Status: 200 OK

{
    "message": "deleted successfully"
}

Nothing to Delete

Status: 200 OK

{
    "messgage": "no items to delete"
}

Salon - Add a Salon

Method & Endpoint

POST /api/salon

Parameters

Name Type In Description
name string body salon name

Default Response

Status: 200 OK

21

Salon - Get a Salon

Method & Endpoint

POST /api/salon/[salonId]

Parameters

Name Type In Description
salonId string path salon id

Default Response

Status: 200 OK

{
    "id": 7,
    "name": "my first salon updated",
    "creator_nickname": "myNickname",
    "books": [
        {
            "id": 16,
            "title": "add book",
            "author": "add author",
            "description": "desdcccc"
        }
    ],
    "participants": [
        {
            "id": 35,
            "login_id": "myId",
            "nickname": "myNickname"
        }
    ]
}

Salon - Create a Salon

Method & Endpoint

POST /api/salon

Parameters

Name Type In Description
name string body salon name

Default Response

Status: 201 Created

34 (Salon Id)

Salon - Modify a Salon

Method & Endpoint

PATCH /api/salon/[salonId]

Parameters

Name Type In Description
salonId string path salon id
name string body new salon name

Default Response

Status: 200 OK

{
    "message": "modified successfully"
}

Salon - Delete a Salon

Method & Endpoint

GET /api/salon/[salonId]

Parameters

Name Type In Description
salonId string path salon id

Default Response

Status: 200 OK

{
    "message": "deleted successfully"
}

Nothing to Delete

Status: 200 OK

{
    "messgage": "no items to delete"
}

Salon - Get a Book in the Salon

Method & Endpoint

GET /api/salon/[salonId]/book/[bookId]

Parameters

Name Type In Description
salonId string path salon id
bookId string path book id

Default Response

Status: 200 OK

{
    "id": 16,
    "title": "add book",
    "author": "add author",
    "description": "desdcccc",
    "reviews": [
        {
            "id": 13,
            "title": "my review",
            "content": "my salon review",
            "reviewer": "myNickname",
            "created_at": "2021-03-16T12:35:37.000Z",
            "updated_at": "2021-03-16T12:35:37.000Z",
            "book_title": "add book",
            "book_author": "add author",
            "salon": "my first salon updated",
            "space": null
        },
    ],
    "quotes": [
        {
            "id": 11,
            "content": "my comment",
            "page": 123,
            "quoter": "myNickname",
            "created_at": "2021-03-16T12:41:05.000Z",
            "updated_at": "2021-03-16T12:41:05.000Z",
            "book_title": "add book",
            "book_author": "add author",
            "salon": "my first salon updated",
            "space": null
        },
    ]
}

Salon - Add a Book to the Salon

Method & Endpoint

POST /api/salon/[salonId]/book

Parameters

Name Type In Description
salonId string path salon id
title string body book title
author string body book author
description string body book description

Default Response

Status: 201 Created

365 (Book Id)

Salon - Delete a Book from the Salon

Method & Endpoint

DELETE /api/salon/[salonId]/book/[bookId]

Parameters

Name Type In Description
salonId string path salon id
bookId string path book id

Default Response

Status: 200 OK

{ "message": "deleted successfully" }

Nothing to Delete

Status: 200 OK

{
    "messgage": "no items to delete"
}

Salon - Create a Review

Method & Endpoint

POST /api/salon/[salonId]/book/[bookId]/review

Parameters

Name Type In Description
salonId string path salon id
bookId string path book id
title string body review title
content string body review content

Default Response

Status: 201 Created

36 (Review Id)

Salon - Modify a Review

Method & Endpoint

PATCH /api/salon/[salonId]/book/[bookId]/review/[reviewId]

Parameters

Name Type In Description
salonId string path salon id
bookId string path book id
reviewId string path review id
title string body new review title
content string body new review content

Default Response

Status: 200 OK

{
    "message": "modified successfully"
}

Salon - Delete a Review

Method & Endpoint

DELETE /api/salon/[salonId]/book/[bookId]/review/[reviewId]

Parameters

Name Type In Description
salonId string path salon id
bookId string path book id
reviewId string path review id

Default Response

Status: 200 OK

{
    "message": "deleted successfully"
}

Nothing to Delete

Status: 200 OK

{
    "messgage": "no items to delete"
}

Salon - Get all Review Comments in a Review

Method & Endpoint

GET /api/salon/[salonId]/book/[bookId]/review/[reviewId]/comment

Parameters

Name Type In Description
salonId string path salon id
bookId string path book id
reviewId string path review id

Default Response

Status: 200 OK

[
    {
        "id": 9,
        "comment": "sadfadfkah",
        "created_at": "2021-03-16T07:24:00.000Z",
        "updated_at": "2021-03-16T07:24:00.000Z",
        "commenter": "myNickname"
    },
]

Salon - Create a Review Comment

Method & Endpoint

POST /api/salon/[salonId]/book/[bookId]/review/[reviewId]/comment

Parameters

Name Type In Description
salonId string path salon id
bookId string path book id
comment string body review comment

Default Response

Status: 201 Created

36 (Review Comment Id)

Salon - Modify a Review Comment

Method & Endpoint

PATCH /api/salon/[salonId]/book/[bookId]/review/[reviewId]/comment/[commentId]

Parameters

Name Type In Description
salonId string path salon id
bookId string path book id
reviewId string path review id
commentId string path comment id
comment string body review comment

Default Response

Status: 200 OK

{
    "message": "modified successfully"
}

Salon - Delete a Review Comment

Method & Endpoint

DELETE /api/salon/[salonId]/book/[bookId]/review/[reviewId]/comment/[commentId]

Parameters

Name Type In Description
salonId string path salon id
bookId string path book id
reviewId string path review id
commentId string path comment id

Default Response

Status: 200 OK

{
    "message": "deleted successfully"
}

Nothing to Delete

Status: 200 OK

{
    "messgage": "no items to delete"
}

Salon - Create a Quote

Method & Endpoint

POST /api/salon/[salonId]/book/[bookId]/quote

Parameters

Name Type In Description
salonId string path salon id
bookId string path book id
content string body quote content
page string body quote page

Default Response

Status: 201 Created

36 (quote Id)

Salon - Modify a Quote

Method & Endpoint

PATCH /api/salon/[salonId]/book/[bookId]/quote/[quoteId]

Parameters

Name Type In Description
salonId string path salon id
bookId string path book id
quoteId string path quote id
content string body new quote content
page string body new quote page

Default Response

Status: 200 OK

{
    "message": "modified successfully"
}

Salon - Delete a Quote

Method & Endpoint

DELETE /api/salon/[salonId]/book/[bookId]/quote/[quoteId]

Parameters

Name Type In Description
salonId string path salon id
bookId string path book id
quoteId string path quote id

Default Response

Status: 200 OK

{
    "message": "deleted successfully"
}

Nothing to Delete

Status: 200 OK

{
    "messgage": "no items to delete"
}

Salon - Get all quote Comments in a Quote

Method & Endpoint

GET /api/salon/[salonId]/book/[bookId]/quote/[quoteId]/comment

Parameters

Name Type In Description
salonId string path salon id
bookId string path book id
quoteId string path quote id

Default Response

Status: 200 OK

[
    {
        "id": 12,
        "comment": "my comment",
        "created_at": "2021-03-16T12:43:00.000Z",
        "updated_at": "2021-03-16T12:43:00.000Z",
        "commenter": "myNickname"
    },
]

Salon - Create a Quote Comment

Method & Endpoint

POST /api/salon/[salonId]/book/[bookId]/quote/[quoteId]/comment

Parameters

Name Type In Description
salonId string path salon id
bookId string path book id
comment string body quote comment

Default Response

Status: 201 Created

36 (quote Comment Id)

Salon - Modify a Quote Comment

Method & Endpoint

PATCH /api/salon/[salonId]/book/[bookId]/quote/[quoteId]/comment/[commentId]

Parameters

Name Type In Description
salonId string path salon id
bookId string path book id
quoteId string path quote id
commentId string path comment id
comment string body quote comment

Default Response

Status: 200 OK

{
    "message": "modified successfully"
}

Salon - Delete a Quote Comment

Method & Endpoint

DELETE /api/salon/[salonId]/book/[bookId]/quote/[quoteId]/comment/[commentId]

Parameters

Name Type In Description
salonId string path salon id
bookId string path book id
quoteId string path quote id
commentId string path comment id

Default Response

Status: 200 OK

{
    "message": "deleted successfully"
}

Nothing to Delete

Status: 200 OK

{
    "messgage": "no items to delete"
}