-
Notifications
You must be signed in to change notification settings - Fork 1
User API Specification
BangDori edited this page Apr 13, 2024
·
24 revisions
κΈ°λ₯ | λ©μλ | URI | λΉκ³ |
---|---|---|---|
νλ‘μ° μμ² | POST | /users/{user_id}/follow | |
μ¬μ©μ κ²μ | GET | /users | |
μ¬μ©μ νλ‘ν μ‘°ν | GET | /users/{user_id} |
- β : νμΈ μλ£
β οΈ : λκΈ° μν- β: λ Όμ νμ
interface User {
id: number;
profile_image: string;
name: string;
content: string;
relationship_status: "self" | "following" | "none"; // π¨ μ§λ¬Έ 리μ€νΈ 3
}
interface Feed {
id: string | number; // π¨ μ§λ¬Έ 리μ€νΈ 2
title: string;
content: string;
image: string;
like_count: number;
comment_count: number;
};
interface Request {
uri: '/users/{user_id}/follow';
method: 'POST';
body : {
user_id: number;
}
}
interface Response {
code: '2000';
data: {
// π¨ μ§λ¬Έ 리μ€νΈ 1
};
}
μ°μ λͺ¨λ μ λ ₯μΌλ‘ μ§ν, μΆν μ°λ‘νλ§ / λλ°μ΄μ€ λμ κ°λ₯
// μΌλ° μ¬μ©μ κ²μ
interface Request {
uri: "/search/users";
method: "GET"
query:{
user_id: number;
}
}
interface Response {
code: "2000";
data:{
domains: User[] // 0οΈβ£ User
}
}
// μ’μμ μ¬μ©μ κ²μ
interface Request {
uri: "/search/like";
method: "GET"
query:{
user_id: number;
}
}
interface Response {
code: "2000";
data:{
domains: User[] // 0οΈβ£ User
}
}
// μ¬μ©μ + (κ²μλ¬Ό κ²μ - μΆν λ±λ‘λλ€λ©΄)
`/search/top?q=${}`
// (κ²μλ¬Ό κ²μ - μΆν λ±λ‘λλ€λ©΄)
`/search/posts?q=${}`
interface Request {
uri: '/users/{user_id}';
method: 'GET';
}
interface Response {
code: "2000";
data : {
user: User; // 0οΈβ£ User
feeds: Feed[]; // 0οΈβ£ Feed
}
}
- μμ± μλ£, μ’μμ μ±κ³΅, μ κ³ μ±κ³΅μ λν μλ΅ λ°μ΄ν°λ 무μμΌλ‘ μ€μ ν΄μΌ νλμ?
- κ²μλ¬Ό, μ μ μ κ°μ κ³ μ Id νμ
νμ νμ (
string
vsbigint
) - νλ‘μ° μ¬λΆμ μκΈ° κ²μλ¬Ό μ¬λΆμ λν μ¬λΆ 체νΉμ λν λ°©λ²
- λ³μ νλλ‘ μ²΄ν¬νλ λ°©λ²
relationship_status: 'self' | 'following' | 'none'
- λ³μ λκ°λ‘ 체ν¬νλ λ°©λ²
is_follow: boolean
is_self_feed: boolean
- λ³μ νλλ‘ μ²΄ν¬νλ λ°©λ²