SpringNote API (1.0.0)

Download OpenAPI specification:Download

SpringNote API 문서

Auth API

회원 탈퇴 합니다. (AUTH-LEVEL : USER)

query Parameters

captchaToken

required

string

캡차 토큰

Responses

자신의 정보를 반환합니다. (AUTH-LEVEL : USER)

Responses

Response samples

200

Content type

application/json

{"admin": false,
"display_name": "testDisplayName",
"enabled": true,
"profile_img": "testProfileImage",
"uid": "testUid"
}

회원 가입 합니다. (AUTH-LEVEL : NONE)

query Parameters

captchaToken

required

string

캡차 토큰

Responses

BadWord API

금칙어 정보를 조회합니다. (AUTH-LEVEL : ADMIN)

사용 가능 쿼리 파라미터 (대소문자 구분 없음)

키	설명	제약
type	true 비속어, false 허용단어	1 종류만 입력 가능
word	해당 word를 포함하는 단어를 찾습니다.	공백이 없는 2~10자

페이징

해당 API는 페이징을 지원합니다.

키	설명	제약	기본값
size	페이징 사이즈	최대 100까지	20
page	페이지 넘버 *0부터 시작		0
sort	정렬 옵션	아래 사용 가능 키만 가능	id;DESC

사용 가능한 sort키는 아래와 같습니다. 모든 Sort 사용시 방향을 지정하지 않으면 ASC 로 동작합니다. (대소문자 구분 없음)

키	설명
id	금칙어 id
word	금칙어 단어
type	금칙어 유형

Responses

Response samples

200

Content type

application/hal+json

{"_embedded": {"bad_words": [{"_links": {"delete": {"href": "http://localhost:8080/api/v1/bad-word/1"
},
"self": {"href": "http://localhost:8080/api/v1/bad-word/1"
}
},
"id": 1,
"is_bad_word": true,
"word": "word"
}
]
},
"_links": {"self": {"href": "http://localhost:8080/api/v1/bad-word?page=0&size=20&sort=id,desc"
}
},
"page": {"number": 0,
"size": 20,
"totalElements": 1,
"totalPages": 1
}
}

금칙어를 생성합니다. (AUTH-LEVEL : ADMIN)

Request Body schema: application/json;charset=UTF-8

is_bad_word	boolean 금칙어 여부
word	string 공백 없는 단어 (2자 이상, 15자 이하)

Responses

Request samples

Payload

Content type

application/json;charset=UTF-8

{"is_bad_word": true,
"word": "15자이하"
}

Response samples

200

Content type

application/hal+json

{"_links": {"delete": {"href": "http://localhost:8080/api/v1/bad-word/1"
},
"self": {"href": "http://localhost:8080/api/v1/bad-word/1"
}
},
"id": 1,
"is_bad_word": true,
"word": "word"
}

금칙어 목록을 갱신합니다. (AUTH-LEVEL : ADMIN)

Responses

Response samples

200

Content type

application/json

{"message": "금칙어 목록을 갱신했습니다."
}

해당하는 ID의 금칙어 정보를 삭제합니다. (AUTH-LEVEL : ADMIN)

path Parameters

id

required

string

금칙어 ID

Responses

해당하는 ID의 금칙어 정보를 조회합니다. (AUTH-LEVEL : ADMIN)

path Parameters

id

required

string

금칙어 ID

Responses

Response samples

200

Content type

application/hal+json

{"_links": {"delete": {"href": "http://localhost:8080/api/v1/bad-word/1"
},
"self": {"href": "http://localhost:8080/api/v1/bad-word/1"
}
},
"id": 1,
"is_bad_word": true,
"word": "word"
}

Comment API

댓글을 삭제합니다.(AUTH_LEVEL: ADMIN)

댓글을 삭제합니다.

path Parameters

commentId

required

string

댓글 ID

Responses

댓글을 조회합니다. (AUTH_LEVEL: NONE)

댓글의 상세 정보를 조회합니다. 만약 댓글이 비활성화 되어있으면, 본문을 확인할 수 없습니다. 관리자의 경우 비활성화 여부와 상관없이 조회 가능합니다.

path Parameters

commentId

required

string

댓글 ID

Responses

Response samples

200

Content type

application/hal+json

{"_links": {"disable": {"href": "http://localhost:8080/api/v1/comment/1/status"
},
"self": {"href": "http://localhost:8080/api/v1/comment/1"
},
"update": {"href": "http://localhost:8080/api/v1/comment/1"
}
},
"content": "test",
"created_date": "2002-08-28T00:00:00",
"enabled": false,
"id": 1,
"last_modified_date": "2002-08-28T00:00:00",
"post_id": 1,
"writer": {"admin": true,
"email": "admin@springnote.blog",
"enabled": true,
"id": "test",
"name": "test",
"profile_img": "https://springnote.blog"
}
}

댓글을 수정합니다.(AUTH_LEVEL: USER)

자기 자신의 댓글만 수정 가능합니다.

path Parameters

commentId

required

string

댓글 ID

Request Body schema: application/json;charset=UTF-8

captcha_token	string 캡차 토큰
content	string 댓글 본문 2~1000자
im_not_bot	boolean honeypot

Responses

Request samples

Payload

Content type

application/json;charset=UTF-8

{"captcha_token": "captchaToken",
"content": "content",
"im_not_bot": null
}

Response samples

200

Content type

application/hal+json

{"_links": {"disable": {"href": "http://localhost:8080/api/v1/comment/1/status"
},
"self": {"href": "http://localhost:8080/api/v1/comment/1"
},
"update": {"href": "http://localhost:8080/api/v1/comment/1"
}
},
"content": "test",
"created_date": "2002-08-28T00:00:00",
"enabled": false,
"id": 1,
"last_modified_date": "2002-08-28T00:00:00",
"post_id": 1,
"writer": {"admin": true,
"email": "admin@springnote.blog",
"enabled": true,
"id": "test",
"name": "test",
"profile_img": "https://springnote.blog"
}
}

해당 댓글에 대한 답글 목록을 반환합니다.(AUTH_LEVEL: NONE)

페이징

해당 API는 페이징을 지원합니다.

키	설명	제약	기본값
size	페이징 사이즈	최대 50까지	20
page	페이지 넘버 *0부터 시작		0
sort	정렬 옵션	아래 사용 가능 키만 가능	createdDate;DESC

사용 가능한 sort키는 아래와 같습니다. 모든 Sort 사용시 방향을 지정하지 않으면 ASC 로 동작합니다. (대소문자 구분 없음)

키	설명
id	댓글 id
user	작성자
createdDate	생성일
lastModifiedDate	마지막 수정일

path Parameters

commentId

required

string

댓글 ID

Responses

Response samples

200

Content type

application/hal+json

{"_embedded": {"replies": [{"_links": {"disable": {"href": "http://localhost:8080/api/v1/comment/1/status"
},
"parent": {"href": "http://localhost:8080/api/v1/comment/1"
},
"self": {"href": "http://localhost:8080/api/v1/comment/1"
},
"update": {"href": "http://localhost:8080/api/v1/comment/1"
}
},
"content": "test",
"created_date": "2002-08-28T00:00:00",
"enabled": false,
"id": 1,
"last_modified_date": "2002-08-28T00:00:00",
"parent_id": 1,
"post_id": 1,
"writer": {"admin": true,
"email": "admin@springnote.blog",
"enabled": true,
"id": "test",
"name": "test",
"profile_img": "https://springnote.blog"
}
}
]
},
"_links": {"self": {"href": "http://localhost:8080/api/v1/comment/1/reply?page=0&size=20&sort=createdDate,desc"
}
},
"page": {"number": 0,
"size": 20,
"totalElements": 1,
"totalPages": 1
}
}

댓글의 상태를 수정합니다.(AUTH_LEVEL: USER)

유저는 댓글을 영구적으로 삭제할 수 없습니다. 따라서 해당 API로 댓글을 비활성화할 수 있습니다.

path Parameters

commentId

required

string

댓글 ID

Responses

Response samples

200

Content type

application/hal+json

{"_links": {"disable": {"href": "http://localhost:8080/api/v1/comment/1/status"
},
"self": {"href": "http://localhost:8080/api/v1/comment/1"
},
"update": {"href": "http://localhost:8080/api/v1/comment/1"
}
},
"content": "test",
"created_date": "2002-08-28T00:00:00",
"enabled": false,
"id": 1,
"last_modified_date": "2002-08-28T00:00:00",
"post_id": 1,
"writer": {"admin": true,
"email": "admin@springnote.blog",
"enabled": true,
"id": "test",
"name": "test",
"profile_img": "https://springnote.blog"
}
}

해당 포스트에 대한 댓글 목록을 반환합니다.(AUTH_LEVEL: NONE)

페이징

해당 API는 페이징을 지원합니다.

키	설명	제약	기본값
size	페이징 사이즈	최대 50까지	20
page	페이지 넘버 *0부터 시작		0
sort	정렬 옵션	아래 사용 가능 키만 가능	createdDate;DESC

사용 가능한 sort키는 아래와 같습니다. 모든 Sort 사용시 방향을 지정하지 않으면 ASC 로 동작합니다. (대소문자 구분 없음)

키	설명
id	댓글 id
user	작성자
createdDate	생성일
lastModifiedDate	마지막 수정일

path Parameters

postId

required

string

포스트 ID

Responses

Response samples

200

Content type

application/hal+json

{"_embedded": {"comments": [{"_links": {"disable": {"href": "http://localhost:8080/api/v1/comment/1/status"
},
"self": {"href": "http://localhost:8080/api/v1/comment/1"
},
"update": {"href": "http://localhost:8080/api/v1/comment/1"
}
},
"content": "test",
"created_date": "2002-08-28T00:00:00",
"enabled": false,
"id": 1,
"last_modified_date": "2002-08-28T00:00:00",
"post_id": 1,
"reply_count": 1,
"writer": {"admin": true,
"email": "admin@springnote.blog",
"enabled": true,
"id": "test",
"name": "test",
"profile_img": "https://springnote.blog"
}
}
]
},
"_links": {"self": {"href": "http://localhost:8080/api/v1/post/1/comment?page=0&size=20&sort=createdDate,desc"
}
},
"page": {"number": 0,
"size": 20,
"totalElements": 1,
"totalPages": 1
}
}

댓글을 생성합니다.(AUTH_LEVEL: USER)

path Parameters

postId

required

string

Request Body schema: application/json;charset=UTF-8

captcha_token	string 캡차 토큰
content	string 댓글 본문 2~1000자
im_not_bot	boolean honeypot

Responses

Request samples

Payload

Content type

application/json;charset=UTF-8

{"captcha_token": "captchaToken",
"content": "content",
"im_not_bot": null
}

Response samples

200

Content type

application/hal+json

{"_links": {"disable": {"href": "http://localhost:8080/api/v1/comment/1/status"
},
"self": {"href": "http://localhost:8080/api/v1/comment/1"
},
"update": {"href": "http://localhost:8080/api/v1/comment/1"
}
},
"content": "test",
"created_date": "2002-08-28T00:00:00",
"enabled": false,
"id": 1,
"last_modified_date": "2002-08-28T00:00:00",
"post_id": 1,
"writer": {"admin": true,
"email": "admin@springnote.blog",
"enabled": true,
"id": "test",
"name": "test",
"profile_img": "https://springnote.blog"
}
}

답글을 생성합니다.(AUTH_LEVEL: USER)

path Parameters

postId required	string 포스트 ID
commentId required	string 댓글 ID

Request Body schema: application/json;charset=UTF-8

captcha_token	string 캡차 토큰
content	string 답글 본문 2~1000자
im_not_bot	boolean honeypot

Responses

Request samples

Payload

Content type

application/json;charset=UTF-8

{"captcha_token": "captchaToken",
"content": "content",
"im_not_bot": null
}

Response samples

200

Content type

application/hal+json

{"_links": {"disable": {"href": "http://localhost:8080/api/v1/comment/1/status"
},
"self": {"href": "http://localhost:8080/api/v1/comment/1"
},
"update": {"href": "http://localhost:8080/api/v1/comment/1"
}
},
"content": "test",
"created_date": "2002-08-28T00:00:00",
"enabled": false,
"id": 1,
"last_modified_date": "2002-08-28T00:00:00",
"post_id": 1,
"writer": {"admin": true,
"email": "admin@springnote.blog",
"enabled": true,
"id": "test",
"name": "test",
"profile_img": "https://springnote.blog"
}
}

Config API

설정 값을 가져옵니다. (AUTH-LEVEL : ADMIN)

path Parameters

key

required

string

설정 키

Responses

Response samples

200

Content type

application/hal+json

{"_links": {"self": {"href": "http://localhost:8080/api/v1/config/key"
}
},
"key": "key",
"value": "value"
}

설정 값을 업데이트합니다. (AUTH-LEVEL : ADMIN)

path Parameters

key

required

string

설정 키

query Parameters

value

required

string

설정 값

Responses

Response samples

200

Content type

application/hal+json

{"_links": {"self": {"href": "http://localhost:8080/api/v1/config/key"
}
},
"key": "key",
"value": "value"
}

Post API

포스트를 조회합니다. (AUTH-LEVEL : NONE)

사용 가능 쿼리 파라미터 (대소문자 구분 없음)

키	설명	제약	기본값
postType	포스트의 유형입니다.		x
series	포스트의 시리즈 입니다.		x
tag	포스트의 태그 정보 입니다.	최대 10개 까지만 사용가능, 중복 불가	x
isOnlyOpenPost	공개된 포스트만 검색할지 여부입니다. true면 공개된 포스트만 검색합니다. 단 false 사용시에는 관리자 권한을 요구합니다.	1개만 사용가능	유저일경우 true, 관리자일 경우 false

페이징

해당 API는 페이징을 지원합니다.

키	설명	제약	기본값
size	페이징 사이즈	최대 100까지	20
page	페이지 넘버 *0부터 시작		0
sort	정렬 옵션	아래 사용 가능 키만 가능	createdDate;DESC

사용 가능한 sort키는 아래와 같습니다. 모든 Sort 사용시 방향을 지정하지 않으면 ASC 로 동작합니다. (대소문자 구분 없음)

키	설명
id	포스트 ID
title	포스트 제목
content	포스트 본문
isOpen	공개 여부
series	시리즈
lastModifiedDate	마지막 수정일
createdDate	생성일

키워드 검색 제목, 본문, 제목 + 본문에 대한 키워드 검색을 지원합니다. 쿼리파라미터에 아래 키를 사용하면 키워드 검색을 수행할 수 있습니다. 이때 아래 두개의 키가 모두 입력되지 않았을 경우 에러가 발생합니다.

키	설명	제약
keyword	검색할 키워드	2~20자
searchMode	검색 모드, TITLE(제목),CONTENT(본문),MIX(제목+본문) 중 1택	1개의 옵션만 설정가능

Responses

Response samples

200

Content type

application/hal+json

{"_embedded": {"posts": [{"_links": {"delete": {"href": "http://localhost:8080/api/v1/post/1"
},
"self": {"href": "http://localhost:8080/api/v1/post/1"
},
"update": {"href": "http://localhost:8080/api/v1/post/1"
},
"update-status": {"href": "http://localhost:8080/api/v1/post/1/status"
}
},
"created_at": "2002-08-28T00:00:00",
"enabled": true,
"id": 1,
"last_updated_at": "2002-08-28T00:00:00",
"post_type": {"id": 1,
"name": "name"
},
"series": {"id": 1,
"name": "name"
},
"tags": [{"id": 1,
"name": "tag1"
},
{"id": 2,
"name": "tag2"
}
],
"thumbnail": "thumbnail",
"title": "title"
}
]
},
"_links": {"self": {"href": "http://localhost:8080/api/v1/post?page=0&size=20&sort=createdDate,desc"
}
},
"page": {"number": 0,
"size": 20,
"totalElements": 1,
"totalPages": 1
}
}

포스트를 생성합니다. (AUTH-LEVEL : ADMIN)

Request Body schema: application/json;charset=UTF-8

content	string 포스트의 내용, 3~65535자
enabled	boolean 포스트의 공개 여부
post_type_id	number 포스트의 타입 ID
series_id	number 포스트의 시리즈 ID, 만약 시리즈가 필요 없는 포스트는 null
	Array of objects 포스트의 태그 ID 리스트
thumbnail	string 포스트의 썸네일 URL, 빈 문자열 가능
title	string 포스트의 제목, 3~300자

Responses

Request samples

Payload

Content type

application/json;charset=UTF-8

{"content": "content",
"enabled": true,
"post_type_id": 1,
"series_id": 1,
"tags": [{"id": 1
},
{"id": 2
}
],
"thumbnail": "http://springnote.blog",
"title": "title"
}

Response samples

200

Content type

application/hal+json

{"_links": {"delete": {"href": "http://localhost:8080/api/v1/post/1"
},
"self": {"href": "http://localhost:8080/api/v1/post/1"
},
"update": {"href": "http://localhost:8080/api/v1/post/1"
},
"update-status": {"href": "http://localhost:8080/api/v1/post/1/status"
}
},
"content": {"editor_text": "editorText",
"plain_text": "plainText"
},
"created_at": "2002-08-28T00:00:00",
"enabled": true,
"id": 1,
"last_updated_at": "2002-08-28T00:00:00",
"post_type": {"id": 1,
"name": "name"
},
"series": {"id": 1,
"name": "name"
},
"tags": [{"id": 1,
"name": "tag1"
},
{"id": 2,
"name": "tag2"
}
],
"thumbnail": "thumbnail",
"title": "title"
}

해당 제목을 가진 포스트가 있는지 검색합니다. (AUTH-LEVEL : ADMIN)

path Parameters

title

required

string

조회할 대상 포스트의 이름, 3~300자

Responses

Response samples

200

Content type

application/json

{"passed": false
}

포스트를 삭제합니다. (AUTH-LEVEL : ADMIN)

path Parameters

id

required

string

삭제할 포스트의 ID

Responses

포스트 ID로 포스트를 조회합니다. (AUTH-LEVEL : NONE)

해당 하는 포스트 ID를 가진 포스트를 반환합니다. 이때 비활성화된 포스트는 관리자만 조회할 수 있습니다.

path Parameters

id

required

number

조회할 대상 포스트 ID, (1~4294967295)

Responses

Response samples

200

Content type

application/hal+json

{"_links": {"delete": {"href": "http://localhost:8080/api/v1/post/1"
},
"self": {"href": "http://localhost:8080/api/v1/post/1"
},
"update": {"href": "http://localhost:8080/api/v1/post/1"
},
"update-status": {"href": "http://localhost:8080/api/v1/post/1/status"
}
},
"content": {"editor_text": "editorText",
"plain_text": "plainText"
},
"created_at": "2002-08-28T00:00:00",
"enabled": true,
"id": 1,
"last_updated_at": "2002-08-28T00:00:00",
"post_type": {"id": 1,
"name": "name"
},
"series": {"id": 1,
"name": "name"
},
"tags": [{"id": 1,
"name": "tag1"
},
{"id": 2,
"name": "tag2"
}
],
"thumbnail": "thumbnail",
"title": "title"
}

포스트를 수정합니다. (AUTH-LEVEL : ADMIN)

path Parameters

id

required

string

수정할 포스트의 ID

Request Body schema: application/json;charset=UTF-8

content	string 포스트의 내용, 3~65535자
enabled	boolean 포스트의 공개 여부
series_id	number 포스트의 시리즈 ID, 만약 시리즈가 필요 없는 포스트는 null
	Array of objects 포스트의 태그 ID 리스트
thumbnail	string 포스트의 썸네일 URL, 빈 문자열 가능
title	string 포스트의 제목, 3~300자

Responses

Request samples

Payload

Content type

application/json;charset=UTF-8

{"content": "content",
"enabled": true,
"series_id": 1,
"tags": [{"id": 1
},
{"id": 2
}
],
"thumbnail": "http://springnote.blog",
"title": "title"
}

Response samples

200

Content type

application/hal+json

{"_links": {"delete": {"href": "http://localhost:8080/api/v1/post/1"
},
"self": {"href": "http://localhost:8080/api/v1/post/1"
},
"update": {"href": "http://localhost:8080/api/v1/post/1"
},
"update-status": {"href": "http://localhost:8080/api/v1/post/1/status"
}
},
"content": {"editor_text": "editorText",
"plain_text": "plainText"
},
"created_at": "2002-08-28T00:00:00",
"enabled": true,
"id": 1,
"last_updated_at": "2002-08-28T00:00:00",
"post_type": {"id": 1,
"name": "name"
},
"series": {"id": 1,
"name": "name"
},
"tags": [{"id": 1,
"name": "tag1"
},
{"id": 2,
"name": "tag2"
}
],
"thumbnail": "thumbnail",
"title": "title"
}

포스트의 상태를 수정합니다. (AUTH-LEVEL : ADMIN)

path Parameters

id

required

string

수정할 포스트의 ID

Request Body schema: application/json;charset=UTF-8

enabled

boolean

포스트의 공개 여부

Responses

Request samples

Payload

Content type

application/json;charset=UTF-8

{"enabled": true
}

Response samples

200

Content type

application/hal+json

{"_links": {"delete": {"href": "http://localhost:8080/api/v1/post/1"
},
"self": {"href": "http://localhost:8080/api/v1/post/1"
},
"update": {"href": "http://localhost:8080/api/v1/post/1"
},
"update-status": {"href": "http://localhost:8080/api/v1/post/1/status"
}
},
"content": {"editor_text": "editorText",
"plain_text": "plainText"
},
"created_at": "2002-08-28T00:00:00",
"enabled": true,
"id": 1,
"last_updated_at": "2002-08-28T00:00:00",
"post_type": {"id": 1,
"name": "name"
},
"series": {"id": 1,
"name": "name"
},
"tags": [{"id": 1,
"name": "tag1"
},
{"id": 2,
"name": "tag2"
}
],
"thumbnail": "thumbnail",
"title": "title"
}

PostType API

포스트 타입을 가져옵니다.

페이징

해당 API는 페이징을 지원합니다.

키	설명	제약	기본값
size	페이징 사이즈	최대 20까지	20
page	페이지 넘버 *0부터 시작		0
sort	정렬 옵션	아래 사용 가능 키만 가능	id;DESC

사용 가능한 sort키는 아래와 같습니다. 모든 Sort 사용시 방향을 지정하지 않으면 ASC 로 동작합니다. (대소문자 구분 없음)

키	설명
id	타입 ID
name	이름

Responses

Response samples

200

Content type

application/hal+json

{"_embedded": {"post_types": [{"id": 1,
"name": "name"
}
]
},
"_links": {"self": {"href": "http://localhost:8080/api/v1/post-type?page=0&size=20&sort=id,desc"
}
},
"page": {"number": 0,
"size": 20,
"totalElements": 1,
"totalPages": 1
}
}

Series API

시리즈를 조회합니다.

사용 가능 쿼리 파라미터 (대소문자 구분 없음)

키	설명	제약	기본값
name	검색할 이름.	2~40자	x

페이징

해당 API는 페이징을 지원합니다.

키	설명	제약	기본값
size	페이징 사이즈	최대 50까지	20
page	페이지 넘버 *0부터 시작		0
sort	정렬 옵션	아래 사용 가능 키만 가능	id;DESC

사용 가능한 sort키는 아래와 같습니다. 모든 Sort 사용시 방향을 지정하지 않으면 ASC 로 동작합니다. (대소문자 구분 없음)

키	설명
id	시리즈 ID
name	시리즈 제목

Responses

Response samples

200

Content type

application/hal+json

{"_embedded": {"series": [{"_links": {"delete": {"href": "http://localhost:8080/api/v1/series/1"
},
"self": {"href": "http://localhost:8080/api/v1/series/1"
},
"update": {"href": "http://localhost:8080/api/v1/series/1"
}
},
"description": "test",
"id": 1,
"name": "test",
"thumbnail": "https://springnote.blog"
}
]
},
"_links": {"self": {"href": "http://localhost:8080/api/v1/series?page=0&size=20&sort=id,desc"
}
},
"page": {"number": 0,
"size": 20,
"totalElements": 1,
"totalPages": 1
}
}

시리즈를 생성합니다. (AUTH_LEVEL: ADMIN)

Request Body schema: application/json;charset=UTF-8

description	string 시리즈 설명
name	string 시리즈 이름
thumbnail	string 시리즈 썸네일

Responses

Request samples

Payload

Content type

application/json;charset=UTF-8

{"description": "test",
"name": "test",
"thumbnail": "https://springnote.blog"
}

Response samples

200

Content type

application/hal+json

{"_links": {"delete": {"href": "http://localhost:8080/api/v1/series/1"
},
"self": {"href": "http://localhost:8080/api/v1/series/1"
},
"update": {"href": "http://localhost:8080/api/v1/series/1"
}
},
"description": "test",
"id": 1,
"name": "test",
"thumbnail": "https://springnote.blog"
}

시리즈를 삭제합니다. (AUTH_LEVEL: ADMIN)

주어진 id에 해당하는 시리즈를 삭제합니다. 이때 해당 시리즈에 속한 모든 포스트도 삭제됩니다.

path Parameters

seriesId

required

string

삭제할 시리즈의 ID

Responses

주어진 Id에 해당하는 시리즈를 조회합니다.

path Parameters

seriesId

required

string

조회할 시리즈의 ID

Responses

Response samples

200

Content type

application/hal+json

{"_links": {"delete": {"href": "http://localhost:8080/api/v1/series/1"
},
"self": {"href": "http://localhost:8080/api/v1/series/1"
},
"update": {"href": "http://localhost:8080/api/v1/series/1"
}
},
"description": "test",
"id": 1,
"name": "test",
"thumbnail": "https://springnote.blog"
}

시리즈를 수정합니다. (AUTH_LEVEL: ADMIN)

path Parameters

seriesId

required

string

수정할 시리즈의 ID

Request Body schema: application/json;charset=UTF-8

description	string 시리즈 설명
name	string 시리즈 이름
thumbnail	string 시리즈 썸네일

Responses

Request samples

Payload

Content type

application/json;charset=UTF-8

{"description": "test",
"name": "test",
"thumbnail": "https://springnote.blog"
}

Response samples

200

Content type

application/hal+json

{"_links": {"delete": {"href": "http://localhost:8080/api/v1/series/1"
},
"self": {"href": "http://localhost:8080/api/v1/series/1"
},
"update": {"href": "http://localhost:8080/api/v1/series/1"
}
},
"description": "test",
"id": 1,
"name": "test",
"thumbnail": "https://springnote.blog"
}

임시 포스트를 조회합니다. (AUTH_LEVEL: ADMIN)

path Parameters

tmpPostId

required

string

임시 포스트 ID

Responses

Response samples

200

Content type

application/hal+json

{"_links": {"delete": {"href": "http://localhost:8080/api/v1/tmp-post/eeef2080-8519-46de-a1d1-8901e8c4f04e"
},
"self": {"href": "http://localhost:8080/api/v1/tmp-post/eeef2080-8519-46de-a1d1-8901e8c4f04e"
},
"update": {"href": "http://localhost:8080/api/v1/tmp-post/eeef2080-8519-46de-a1d1-8901e8c4f04e"
}
},
"content": "content",
"created_at": "2002-08-28T00:00:00",
"id": "eeef2080-8519-46de-a1d1-8901e8c4f04e",
"last_updated_at": "2002-08-28T00:00:00",
"post_type": {"id": 1,
"name": "postType"
},
"series": {"id": 1,
"name": "series"
},
"tags": [{"id": 1,
"name": "tag1"
},
{"id": 2,
"name": "tag2"
}
],
"thumbnail": "http://springnote.blog",
"title": "title"
}

SiteContent API

사이트 콘텐츠를 생성합니다. (AUTH_LEVEL: ADMIN)

Request Body schema: application/json;charset=UTF-8

content	string 사이트 콘텐츠의 내용 (1~30000자)
key	string 사이트 콘텐츠의 키 (공백 없이 1~300자)

Responses

Request samples

Payload

Content type

application/json;charset=UTF-8

{"content": "test content",
"key": "test"
}

Response samples

200

Content type

application/hal+json

{"_links": {"self": {"href": "http://localhost:8080/api/v1/site-content/test"
}
},
"content": "test content",
"key": "test"
}

사이트 콘텐츠를 삭제합니다. (AUTH_LEVEL: ADMIN)

path Parameters

key

required

string

사이트 콘텐츠의 키

Responses

사이트 콘텐츠 ID로 포스트를 조회합니다.

path Parameters

key

required

string

사이트 콘텐츠의 키

Responses

Response samples

200

Content type

application/hal+json

{"_links": {"self": {"href": "http://localhost:8080/api/v1/site-content/test"
}
},
"content": "test content",
"key": "test"
}

사이트 콘텐츠를 수정합니다. (AUTH_LEVEL: ADMIN)

path Parameters

key

required

string

사이트 콘텐츠의 키

Request Body schema: application/json;charset=UTF-8

content

string

사이트 콘텐츠의 내용 (1~30000자)

Responses

Request samples

Payload

Content type

application/json;charset=UTF-8

{"content": "test content"
}

Response samples

200

Content type

application/hal+json

{"_links": {"self": {"href": "http://localhost:8080/api/v1/site-content/test"
}
},
"content": "test content",
"key": "test"
}

Tag API

Tag 목록을 조회합니다.

사용 가능 쿼리 파라미터 (대소문자 구분 없음)

키	설명	제약	기본값
name	검색할 이름입니다.	2~100자	x

페이징

해당 API는 페이징을 지원합니다.

키	설명	제약	기본값
size	페이징 사이즈	최대 20까지	10
page	페이지 넘버 *0부터 시작		0
sort	정렬 옵션	아래 사용 가능 키만 가능	id;DESC

사용 가능한 sort키는 아래와 같습니다. 모든 Sort 사용시 방향을 지정하지 않으면 ASC 로 동작합니다. (대소문자 구분 없음)

키	설명
id	태그 ID
name	태그 이름

Responses

Response samples

200

Content type

application/hal+json

{"_embedded": {"tags": [{"_links": {"delete": {"href": "http://localhost:8080/api/v1/tag/1"
},
"self": {"href": "http://localhost:8080/api/v1/tag/1"
},
"update": {"href": "http://localhost:8080/api/v1/tag/1"
}
},
"id": 1,
"name": "tag"
}
]
},
"_links": {"self": {"href": "http://localhost:8080/api/v1/tag?page=0&size=10&sort=id,desc"
}
},
"page": {"number": 0,
"size": 10,
"totalElements": 1,
"totalPages": 1
}
}

새로운 태그를 생성합니다. (AUTH_LEVEL: ADMIN)

Request Body schema: application/json;charset=UTF-8

name	string 태그 이름 (2~100자)

Responses

Request samples

Payload

Content type

application/json;charset=UTF-8

{"name": "tag"
}

Response samples

200

Content type

application/hal+json

{"_links": {"delete": {"href": "http://localhost:8080/api/v1/tag/1"
},
"self": {"href": "http://localhost:8080/api/v1/tag/1"
},
"update": {"href": "http://localhost:8080/api/v1/tag/1"
}
},
"id": 1,
"name": "tag"
}

주어진 Id로 태그를 삭제합니다. (AUTH_LEVEL: ADMIN)

path Parameters

id

required

string

삭제할 태그 ID

Responses

주어진 Id로 태그를 수정합니다. (AUTH_LEVEL: ADMIN)

path Parameters

id

required

string

수정할 태그 ID

Request Body schema: application/json;charset=UTF-8

name	string 태그 이름 (2~100자)

Responses

Request samples

Payload

Content type

application/json;charset=UTF-8

{"name": "tag"
}

Response samples

200

Content type

application/hal+json

{"_links": {"delete": {"href": "http://localhost:8080/api/v1/tag/1"
},
"self": {"href": "http://localhost:8080/api/v1/tag/1"
},
"update": {"href": "http://localhost:8080/api/v1/tag/1"
}
},
"id": 1,
"name": "tag"
}

주어진 Id로 태그를 조회합니다.

path Parameters

tagId

required

string

조회할 태그 ID

Responses

Response samples

200

Content type

application/hal+json

{"_links": {"delete": {"href": "http://localhost:8080/api/v1/tag/1"
},
"self": {"href": "http://localhost:8080/api/v1/tag/1"
},
"update": {"href": "http://localhost:8080/api/v1/tag/1"
}
},
"id": 1,
"name": "tag"
}

TmpPost API

임시 포스트 목록을 조회합니다. (AUTH_LEVEL: ADMIN)

페이징

해당 API는 페이징을 지원합니다.

키	설명	제약	기본값
size	페이징 사이즈	최대 50까지	20
page	페이지 넘버 *0부터 시작		0
sort	정렬 옵션	아래 사용 가능 키만 가능	createdDate;DESC

사용 가능한 sort키는 아래와 같습니다. 모든 Sort 사용시 방향을 지정하지 않으면 ASC 로 동작합니다. (대소문자 구분 없음)

키	설명
lastModifiedDate	마지막 수정일
createdDate	생성일

Responses

Response samples

200

Content type

application/hal+json

{"_embedded": {"tmp_posts": [{"_links": {"delete": {"href": "http://localhost:8080/api/v1/tmp-post/180f99f5-f28a-40f0-aa5b-6e2e8411f92f"
},
"self": {"href": "http://localhost:8080/api/v1/tmp-post/180f99f5-f28a-40f0-aa5b-6e2e8411f92f"
},
"update": {"href": "http://localhost:8080/api/v1/tmp-post/180f99f5-f28a-40f0-aa5b-6e2e8411f92f"
}
},
"content": "content",
"created_at": "2002-08-28T00:00:00",
"id": "180f99f5-f28a-40f0-aa5b-6e2e8411f92f",
"last_updated_at": "2002-08-28T00:00:00",
"post_type": {"id": 1,
"name": "postType"
},
"series": {"id": 1,
"name": "series"
},
"tags": [{"id": 1,
"name": "tag1"
},
{"id": 2,
"name": "tag2"
}
],
"thumbnail": "http://springnote.blog",
"title": "title"
}
]
},
"_links": {"self": {"href": "http://localhost:8080/api/v1/tmp-post?page=0&size=20&sort=createdDate,desc"
}
},
"page": {"number": 0,
"size": 20,
"totalElements": 1,
"totalPages": 1
}
}

임시 포스트를 게시합니다. (AUTH_LEVEL: ADMIN)

Request Body schema: application/json;charset=UTF-8

post_type_id

number

포스트 타입 ID

Responses

Request samples

Payload

Content type

application/json;charset=UTF-8

{"content": null,
"post_type_id": 1,
"series_id": null,
"tag_ids": null,
"thumbnail": null,
"title": null
}

Response samples

200

Content type

application/hal+json

{"_links": {"delete": {"href": "http://localhost:8080/api/v1/tmp-post/b8f12cf2-f72a-4b59-9ac4-5cd415a66507"
},
"self": {"href": "http://localhost:8080/api/v1/tmp-post/b8f12cf2-f72a-4b59-9ac4-5cd415a66507"
},
"update": {"href": "http://localhost:8080/api/v1/tmp-post/b8f12cf2-f72a-4b59-9ac4-5cd415a66507"
}
},
"content": "content",
"created_at": "2002-08-28T00:00:00",
"id": "b8f12cf2-f72a-4b59-9ac4-5cd415a66507",
"last_updated_at": "2002-08-28T00:00:00",
"post_type": {"id": 1,
"name": "postType"
},
"series": {"id": 1,
"name": "series"
},
"tags": [{"id": 1,
"name": "tag1"
},
{"id": 2,
"name": "tag2"
}
],
"thumbnail": "http://springnote.blog",
"title": "title"
}

임시 포스트를 삭제합니다. (AUTH_LEVEL: ADMIN)

path Parameters

tmpPostId

required

string

임시 포스트 ID

Responses

임시 포스트를 수정합니다. (AUTH_LEVEL: ADMIN)

path Parameters

tmpPostId

required

string

임시 포스트 ID

Request Body schema: application/json;charset=UTF-8

object (TmpPost.UpdateRequest)

Responses

Request samples

Payload

Content type

application/json;charset=UTF-8

{"content": null,
"series_id": null,
"tag_ids": null,
"thumbnail": null,
"title": null
}

Response samples

200

Content type

application/hal+json

{"_links": {"delete": {"href": "http://localhost:8080/api/v1/tmp-post/8cb09b2f-3bed-4fbf-888e-718a786c9cbd"
},
"self": {"href": "http://localhost:8080/api/v1/tmp-post/8cb09b2f-3bed-4fbf-888e-718a786c9cbd"
},
"update": {"href": "http://localhost:8080/api/v1/tmp-post/8cb09b2f-3bed-4fbf-888e-718a786c9cbd"
}
},
"content": "content",
"created_at": "2002-08-28T00:00:00",
"id": "8cb09b2f-3bed-4fbf-888e-718a786c9cbd",
"last_updated_at": "2002-08-28T00:00:00",
"post_type": {"id": 1,
"name": "postType"
},
"series": {"id": 1,
"name": "series"
},
"tags": [{"id": 1,
"name": "tag1"
},
{"id": 2,
"name": "tag2"
}
],
"thumbnail": "http://springnote.blog",
"title": "title"
}

임시 포스트를 게시합니다. (AUTH_LEVEL: ADMIN)

path Parameters

tmpPostId

required

string

임시 포스트 ID

Responses

Response samples

200

Content type

application/hal+json

{"_links": {"delete": {"href": "http://localhost:8080/api/v1/post/1"
},
"self": {"href": "http://localhost:8080/api/v1/post/1"
},
"update": {"href": "http://localhost:8080/api/v1/post/1"
},
"update-status": {"href": "http://localhost:8080/api/v1/post/1/status"
}
},
"content": {"editor_text": "editorText",
"plain_text": "plainText"
},
"created_at": "2002-08-28T00:00:00",
"enabled": true,
"id": 1,
"last_updated_at": "2002-08-28T00:00:00",
"post_type": {"id": 1,
"name": "name"
},
"series": {"id": 1,
"name": "name"
},
"tags": [{"id": 1,
"name": "tag1"
},
{"id": 2,
"name": "tag2"
}
],
"thumbnail": "thumbnail",
"title": "title"
}