20.03.2023 - ЖЗГ

FastApi: авторизированный вход

20.03.2023 Павел Грибов Python

Из предыдущей статьи у нас есть некий вызов API после выполнения которого у нас на руках будет некий сессионый ключ.

Попробуем теперь используя этот сессионый ключ, запросить некую информацию о пользователе. Для этого добавим в схему auth.py классы:

class info_class(BaseModel):
    username : Optional[str] = Field(None, title="Имя пользователя", example="Вася Пупкин")
    phone    : Optional[str] = Field(None, title="Номер телефона", example="+79222347594")
    email    : Optional[str] = Field(None, title="Email пользователя", example="dowiurefh@mail.ru")

class info_out(BaseModel):
    error     : Optional[bool]  = Field(..., title="Результат выполнения запроса", example="false")
    comment   : Optional[str]   = Field(None, title="Текст ошибки", example="Пользователь удалён")
    result    : Optional[info_class]

class info_class(BaseModel):

username : Optional[str] = Field(None, title="Имя пользователя", example="Вася Пупкин")

phone : Optional[str] = Field(None, title="Номер телефона", example="+79222347594")

email : Optional[str] = Field(None, title="Email пользователя", example="dowiurefh@mail.ru")

class info_out(BaseModel):

error : Optional[bool] = Field(..., title="Результат выполнения запроса", example="false")

comment : Optional[str] = Field(None, title="Текст ошибки", example="Пользователь удалён")

result : Optional[info_class]

Следующим шагом будет защитить доступ к остальным компонентам API, от доступа без сессионного ключа. Для этого воспользуемся классом FastApi security и добавим в требования заголовка запроса тег авторизации.

Получим итоговый роутинг auth.py:

# -*- coding: utf-8 -*-
"""Different helper-functions to work with users."""
import json
import fastapi;
from fastapi import APIRouter,Depends
from app.schemas import auth as auth_models
from pydantic import BaseModel

token_key = fastapi.security.APIKeyHeader(name="Authorization")

class Token(BaseModel):
    token: str

# получить текущий токен
def get_current_token(oauth_header: str = fastapi.Security(token_key)):
    #print(f"Token: {oauth_header}")
    oauth_header=oauth_header.replace("Token ","")
    return oauth_header

router = APIRouter()

@router.post('/auth',response_model=auth_models.auth_out,tags=["auth"]) # заданы исходящие параметры
async def auth(into = Depends(auth_models.auth_in)): # заданы входящие параметры
    # если параметры не заданы
    if into.password==None: into.password="NONE"
    if into.login == None: into.password = "NONE"
    hash="12345678"
    # сформируем ответ
    out=auth_models.auth_out(hash=hash)
    return out

@router.post('/GetInfo',response_model=auth_models.info_out,tags=["auth"]) # заданы исходящие параметры
async def GetInfo(token: Token=Depends(get_current_token)): # заданы входящие параметры
    print(f"Токен: {token}")
    if token!="12345678":
        print("Токен не верен!")
        return auth_models.info_out(error=True,comment="Токен не найден")
    # сформируем ответ

    return auth_models.info_out(error=False,result={"username":"Pavel","email":"vasya@mail.ru"})

# -*- coding: utf-8 -*-

"""Different helper-functions to work with users."""

import json

import fastapi;

from fastapi import APIRouter,Depends

from app.schemas import auth as auth_models

from pydantic import BaseModel

token_key = fastapi.security.APIKeyHeader(name="Authorization")

class Token(BaseModel):

token: str

# получить текущий токен

def get_current_token(oauth_header: str = fastapi.Security(token_key)):

#print(f"Token: {oauth_header}")

oauth_header=oauth_header.replace("Token ","")

return oauth_header

router = APIRouter()

@router.post('/auth',response_model=auth_models.auth_out,tags=["auth"]) # заданы исходящие параметры

async def auth(into = Depends(auth_models.auth_in)): # заданы входящие параметры

# если параметры не заданы

if into.password==None: into.password="NONE"

if into.login == None: into.password = "NONE"

hash="12345678"

# сформируем ответ

out=auth_models.auth_out(hash=hash)

return out

@router.post('/GetInfo',response_model=auth_models.info_out,tags=["auth"]) # заданы исходящие параметры

async def GetInfo(token: Token=Depends(get_current_token)): # заданы входящие параметры

print(f"Токен: {token}")

if token!="12345678":

print("Токен не верен!")

return auth_models.info_out(error=True,comment="Токен не найден")

# сформируем ответ

return auth_models.info_out(error=False,result={"username":"Pavel","email":"vasya@mail.ru"})

В результате мы можем увидеть в документации появившийся «замочек»:

При попытке выполнения запроса без авторизации, соответственно получим ошибку аторизации:

Not authenticated

1	Not authenticated

Оставить комментарий Authorization, fastapi

Настройка внешнего доступа к API

20.03.2023 Павел Грибов Python

В предыдущей статье был рассмотрен запуск сервера и доступ к нему. Одно НО, доступ этот осуществляется или с локального ПК (в main.py), как вы видели присутствует строчка:

uvicorn.run(app, host="127.0.0.1", port=8000, log_level="info")

1	uvicorn.run(app, host="127.0.0.1", port=8000, log_level="info")

Если host поменять например на 0.0.0.0, сервер «из вне» будет конечно доступен, но по нестандартному порту и не по защищенному протоколу. Однако есть способ «завернуть» весь трафик в https через проксирование в apache/ngnix.

Для apache необходимо установить модуль proxy:

sudo a2enmod proxy proxy_http
sudo service apache2 restart

1 2	sudo a2enmod proxy proxy_http sudo service apache2 restart

И в настройки VirtualHost сайта добавить:

ProxyPass / http://127.0.0.1:8000
ProxyPassReverse / http://127.0.0.1:8000

1 2	ProxyPass / http://127.0.0.1:8000 ProxyPassReverse / http://127.0.0.1:8000

Для ngnix к сожалению не могу дать примера, т.к. обычно не использую.

Оставить комментарий apache, fastapi

FastApi: основы

20.03.2023 Павел Грибов Python

Зачем нужно

FastApi — это фреймворк позволяющий создавать «самодокументирующиеся API». Т.е. и реализация и документация пишется прямо в коде. Причем FastApi при помощи вебинтерфейса предоставляет еще и возможность тестирования получившегося API.

Подготовка

Для работы потребуется установленные пакеты fastapi и uvicorn :

pip3 install fastapi
pip3 install uvicorn

1 2	pip3 install fastapi pip3 install uvicorn

uvicorn требуется чтобы запустить веб сервер на определенном порту, для взаимодействия с фреймворком fastapi. Далее его можно проксировать через apache или ngnix, В основном для того, чтобы к api можно было обращаться из вне не только по IP но и по DNS имени. Ну и чтобы обернуть в https. Хотя консольный uvicorn позволяет может запускаться и по https протоколу, если указать ему сертификаты. Но не пробовал, ибо было не нужно.

Еще разик акцентирую внимание: uvicorn может поставляться в виде пакета python или в виде консольной утилиты. По сути это два разных способа поднятия вебсервера для fastapi. Результат будет один. Только в случае использования пакета python — внутри скрипта нужно будет реализовывать запуск uvicorn

Первый шаг

Как происходит работа внешнего пользователя с API? Обычно он авторизуется по логину-паролю, получает «сессионный ключ» и далее работает уже с ним. Что собственно и попробуем реализовать. Сначала на минимальном примере.

В FastApi используется модель pedantic, т.е. на входе функций реализуемых API должно попадать данные согласно заранее построенной схеме. Вызов функции, осуществляется при помощи роутинга в URL.

Например реализуем вызов функции API авторизации по URL вида:

http://127.0.0.1:8000/v1/auth

1	http://127.0.0.1:8000/v1/auth

Запрос к URL будет выполнятся при помощи POST, с параметрами login и password

Создадим следующую структуру файлов и папок:

В файле main.py реализуем запуск сервера uvicorn и начальные настройки для запуска фреймворка FastAPI.

В файле /app/routers/auth.py реализуем логику ответа на вызов URL с параметрами POST

В файле /app/schemas/auth.py — создадим проверку входящих и исходящих параметров вызова согласно схеме pedantic

main.py:

import uvicorn
from fastapi import FastAPI
from app.routers import auth

tags_metadata = [
    {"name": "auth", "description": "Получение ключа по логину, паролю"},
]

app = FastAPI(title="API documentation", description="Какое то описание ",version="0.0.1", openapi_tags=tags_metadata, )

app.include_router(auth.router, prefix="/v1")

if __name__ == "__main__":
    uvicorn.run(app, host="127.0.0.1", port=8000, log_level="info")

import uvicorn

from fastapi import FastAPI

from app.routers import auth

tags_metadata = [

{"name": "auth", "description": "Получение ключа по логину, паролю"},

]

app = FastAPI(title="API documentation", description="Какое то описание ",version="0.0.1", openapi_tags=tags_metadata, )

app.include_router(auth.router, prefix="/v1")

if __name__ == "__main__":

uvicorn.run(app, host="127.0.0.1", port=8000, log_level="info")

Схема auth.py:

# -*- coding: utf-8 -*-

from typing import Optional
from pydantic import BaseModel,Field

class auth_out(BaseModel):
    """ Что Выходит """
    hash: str = Field(..., title="Сессионый ключ полученый по логину - паролю", example="iauwhfpseurh e")

class auth_in(BaseModel):
    """ Что входит """
    login: Optional [str] = Field(..., title="Логин пользователя", example="Например Вася")
    password: Optional [str] =Field(..., title="Пароль пользователя", example="Например IUHID#U$HI")

# -*- coding: utf-8 -*-

from typing import Optional

from pydantic import BaseModel,Field

class auth_out(BaseModel):

""" Что Выходит """

hash: str = Field(..., title="Сессионый ключ полученый по логину - паролю", example="iauwhfpseurh e")

class auth_in(BaseModel):

""" Что входит """

password: Optional [str] =Field(..., title="Пароль пользователя", example="Например IUHID#U$HI")

Роутер auth.py:

# -*- coding: utf-8 -*-
"""Different helper-functions to work with users."""
import json

from fastapi import APIRouter,Depends
from app.schemas import auth as auth_models

router = APIRouter()

@router.post('/auth',response_model=auth_models.auth_out,tags=["auth"]) # заданы исходящие параметры
async def auth(into = Depends(auth_models.auth_in)): # заданы входящие параметры
    # если параметры не заданы
    if into.password==None: into.password="NONE"
    if into.login == None: into.password = "NONE"
    hash="eopwhdfweruieruiopfhp[ruifhp[eruifhperf8yareuifh[ay8wedfper8"
    # сформируем ответ
    out=auth_models.auth_out(hash=hash)
    return out

# -*- coding: utf-8 -*-

"""Different helper-functions to work with users."""

import json

from fastapi import APIRouter,Depends

from app.schemas import auth as auth_models

router = APIRouter()

@router.post('/auth',response_model=auth_models.auth_out,tags=["auth"]) # заданы исходящие параметры

async def auth(into = Depends(auth_models.auth_in)): # заданы входящие параметры

# если параметры не заданы

if into.password==None: into.password="NONE"

if into.login == None: into.password = "NONE"

hash="eopwhdfweruieruiopfhp[ruifhp[eruifhperf8yareuifh[ay8wedfper8"

# сформируем ответ

out=auth_models.auth_out(hash=hash)

return out

Ну вот собственно и всё. Минимальный рабочий каркас собран. Осталось попробовать его запустить и посмотреть результат в браузере. Для этого в консоли запустим:

python main.py

1	python main.py

Далее открываем браузер по url http://127.0.0.1:8000/docs или (http://127.0.0.1:8000/redoc) и можем наблюдать уже сформированную готовую к употреблению документацию:

Причем работоспособность вызовов можно попробовать прямо сейчас.

В текущем случае мы запустили сервер uvicorn из скрипта python, но есть вариант запуска сервера и из консоли. Какие преимущества имеет запуск из консоли, мне не очень пока очевидны. Но факт есть факт. Скрипт можно запустить и так:

uvicorn main:app --port 8000 --workers 10

1 2	uvicorn main:app --port 8000 --workers 10

В данном случае запустили 10 воркеров FastApi. Если использовать ключ —reload, то сервер будет отслеживать изменение файлов и перезапускать сам себя. Это удобно для моментальной отладки

Внимание! Ключи —reload и —workers одновременно не работают.

Оставить комментарий

Пн	Вт	Ср	Чт	Пт	Сб	Вс
		1	2	3	4	5
6	7	8	9	10	11	12
13	14	15	16	17	18	19
20	21	22	23	24	25	26
27	28	29	30	31