Skip to content

API для social_blog написанная на FastAPI. Позволяющая просматривать и создавать посты , просматривать группы, подписываться на авторов постов.

Notifications You must be signed in to change notification settings

CHEDEIV8/social_blog_fastapi

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Проект: social_blog_fastapi


Стек:

Python, FastApi, PostgreSql, SqlAlchemy, Pydantic, fastapi-pagination


Описание:

social_blog_fastapi - это API написанная на FastApi для social_blog. Позволяющая просматривать и создавать посты, просматривать группы, подписываться на авторов постов.

Также см. альтернативную реализацию API на Django Rest Framework.


Как развернуть проект:

  1. Клонировать репозиторий:
	git@github.com:CHEDEIV8/social_blog_fastapi.git
  1. Создать в папке app/ файл .env с переменными окружения (см. .env.example).

  2. Cоздать и активировать виртуальное окружение::

	python -m venv venv
    source venv/Scripts/activate
  1. Обновляем версию pip:
    python -m pip install --upgrade pip
  1. Установить зависимости из файла requirements.txt:
    pip install -r requirements.txt
  1. Запустить проект:
    uvicorn app.main:app

Примеры запросов к API:

  1. Создать пользователя (POST): http://127.0.0.1:8000/api/v1/users/

  2. Получить токен (POST): http://127.0.0.1:8000/api/v1/jwt/create/

  3. Получить список всех постов (GET): http://127.0.0.1:8000/api/v1/posts/

  4. Получить определенный пост (GET): http://127.0.0.1:8000/api/v1/posts/1/

  5. Получить коментарии определенного поста (GET): http://127.0.0.1:8000/api/v1/posts/1/comments/

  6. Получить список всех групп (GET): http://127.0.0.1:8000/api/v1/groups/

  7. Создать новый пост(требуется аутентификация) (POST): http://127.0.0.1:8000/api/v1/posts/

  8. Получить документацию по всем эндпойнтам API (GET): http://127.0.0.1:8000/docs/

Об авторе

Автор проекта: Денис Чередниченко

About

API для social_blog написанная на FastAPI. Позволяющая просматривать и создавать посты , просматривать группы, подписываться на авторов постов.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages