API Documentation
Полный список доступных API endpoints для работы с данными форума
Информация об API
Базовый URL: /api/
Формат ответа: JSON
Методы:
- GET - Получить данные (список или один объект)
- POST - Создать новый объект
- DELETE - Удалить объект
Доступные Endpoints
User
GET
DELETE
/api/users/{id}/
Получить / Удалить объект по ID
UserProfile
GET
DELETE
/api/userprofiles/{user_id}/
Получить / Удалить объект по ID
Section
GET
DELETE
/api/sections/{id}/
Получить / Удалить объект по ID
Topic
GET
DELETE
/api/topics/{id}/
Получить / Удалить объект по ID
Post
GET
DELETE
/api/posts/{id}/
Получить / Удалить объект по ID
Achievement
GET
DELETE
/api/achievements/{id}/
Получить / Удалить объект по ID
UserAchievement
GET
DELETE
/api/userachievements/{id}/
Получить / Удалить объект по ID
UserRank
GET
DELETE
/api/userranks/{id}/
Получить / Удалить объект по ID
UserRankProgress
GET
DELETE
/api/userrankprogresses/{user_id}/
Получить / Удалить объект по ID
Tag
GET
DELETE
/api/tags/{id}/
Получить / Удалить объект по ID
TopicTag
GET
DELETE
/api/topictags/{id}/
Получить / Удалить объект по ID
Certificate
GET
DELETE
/api/certificates/{id}/
Получить / Удалить объект по ID
UserCertificate
GET
DELETE
/api/usercertificates/{id}/
Получить / Удалить объект по ID
Complaint
GET
DELETE
/api/complaints/{id}/
Получить / Удалить объект по ID
Chat
GET
DELETE
/api/chats/{id}/
Получить / Удалить объект по ID
ChatParticipant
GET
DELETE
/api/chatparticipants/{id}/
Получить / Удалить объект по ID
ChatMessage
GET
DELETE
/api/chatmessages/{id}/
Получить / Удалить объект по ID
SystemLog
GET
DELETE
/api/systemlogs/{id}/
Получить / Удалить объект по ID
ForumSetting
GET
DELETE
/api/forumsettings/{id}/
Получить / Удалить объект по ID
PostLike
GET
DELETE
/api/postlikes/{id}/
Получить / Удалить объект по ID
TopicRating
GET
DELETE
/api/topicratings/{id}/
Получить / Удалить объект по ID
UserSubscription
GET
DELETE
/api/usersubscriptions/{id}/
Получить / Удалить объект по ID
TopicSubscription
GET
DELETE
/api/topicsubscriptions/{id}/
Получить / Удалить объект по ID
ModeratorAction
GET
DELETE
/api/moderatoractions/{id}/
Получить / Удалить объект по ID
AdminLog
GET
DELETE
/api/adminlogs/{id}/
Получить / Удалить объект по ID
Notification
GET
DELETE
/api/notifications/{id}/
Получить / Удалить объект по ID
SearchIndex
GET
DELETE
/api/searchindices/{id}/
Получить / Удалить объект по ID
GitHubAuth
GET
DELETE
/api/githubauths/{user_id}/
Получить / Удалить объект по ID
TopicView
GET
DELETE
/api/topicviews/{id}/
Получить / Удалить объект по ID
Примеры использования
1. Получить список всех пользователей:
GET /api/users/
2. Получить пользователя по ID:
GET /api/users/1/
3. Создать нового пользователя:
POST /api/users/
Content-Type: application/json
{
"username": "newuser",
"email": "user@example.com",
"password": "securepassword123",
"role": "user"
}
4. Удалить пользователя:
DELETE /api/users/1/
5. Получить список всех тем:
GET /api/topics/
6. Создать новую тему:
POST /api/topics/
Content-Type: application/json
{
"section_id": 1,
"title": "Новая тема",
"author_id": 1,
"is_pinned": false
}
Советы
- Для тестирования API можно использовать браузер (для GET запросов) или инструменты типа Postman, curl
- Все POST запросы должны содержать заголовок
Content-Type: application/json - При создании объектов через POST, обязательные поля должны быть указаны в теле запроса
- Для DELETE запросов достаточно указать ID объекта в URL