You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{"openapi":"3.1.0","info":{"title":"FastAPI Template","description":"## Настройка\n\n#### Настройка происходит в файле .env его нет в репозитории, т.к. он конфиденциален, но я предоставил файл .env.dist создайте на его основе файл .env и проведите все необходимые настройки.\n\n## Установка зависимостей\n\n#### В основе проекта лежит пакетный менеджер poetry.\n\n`poetry install` - Вариант с использованием poetry.\n\n`pip install -r requirements.txt` - Вариант с использованием pip.\n\n\n## Документация по make командам\n\n`make help` - Команда help отображает список доступных команд и их описание.\n\n`make ref` - Команда ref используется для форматирования кода с помощью ruff и black.\n\n`make dev` - Команда dev запускает приложение в режиме разработки.\n\n`make req` - Команда req обновляет зависимости в [requirements.txt](requirements.txt)\n\n`make migrate` - Команда migrate применяет все ожидающие миграции к базе данных с помощью alembic.\n\n`make generate` - Команда generate используется для генерации новой миграции базы данных с помощью alembic.\n","contact":{"name":"Fast Code","url":"https://fast-code.pro/","email":"fast.code.auth@gmail.com"},"version":"1.0.0"},"servers":[{"url":"/api"}],"paths":{"/auth/email/registration":{"post":{"tags":["auth"],"summary":"Registration","description":"Create user","operationId":"registration_auth_email_registration_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserCreate"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserRead"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/auth/email/token":{"post":{"tags":["auth"],"summary":"Token","description":"Retrieve new access token","operationId":"token_auth_email_token_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserCreate"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessToken"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/users/":{"get":{"tags":["users"],"summary":"Retrieve","description":"Retrieve user","operationId":"retrieve_users__get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserRead"}}}}},"security":[{"APIKeyHeader":[]}]}}},"components":{"schemas":{"AccessToken":{"properties":{"token":{"type":"string","title":"Token","description":"Необходим для запросов к API, действует 24 часа."}},"type":"object","title":"AccessToken"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"UserCreate":{"properties":{"email":{"type":"string","title":"Email"},"password":{"type":"string","title":"Password"}},"type":"object","required":["email","password"],"title":"UserCreate"},"UserRead":{"properties":{"id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Id"},"email":{"type":"string","title":"Email"}},"type":"object","required":["email"],"title":"UserRead"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"securitySchemes":{"APIKeyHeader":{"type":"apiKey","in":"header","name":"access-token"}}}}
1
+
{"openapi":"3.1.0","info":{"title":"FastAPI Template","description":"[Swagger](docs)\n\n## Настройка\n\n#### Настройка происходит в файле .env его нет в репозитории, т.к. он конфиденциален, но я предоставил файл .env.dist создайте на его основе файл .env и проведите все необходимые настройки\n\n## Установка зависимостей\n\n#### В основе проекта лежит пакетный менеджер poetry\n\n`poetry install` - Вариант с использованием poetry.\n\n`pip install -r requirements.txt` - Вариант с использованием pip.\n\n## Документация по make командам\n\n`make help` - Команда help отображает список доступных команд и их описание.\n\n`make ref` - Команда ref используется для форматирования кода с помощью ruff и black.\n\n`make dev` - Команда dev запускает приложение в режиме разработки.\n\n`make req` - Команда req обновляет зависимости в [requirements.txt](requirements.txt)\n\n`make migrate` - Команда migrate применяет все ожидающие миграции к базе данных с помощью alembic.\n\n`make generate` - Команда generate используется для генерации новой миграции базы данных с помощью alembic.\n","contact":{"name":"Fast Code","url":"https://fast-code.pro/","email":"fast.code.auth@gmail.com"},"version":"1.0.0"},"servers":[{"url":"/api"}],"paths":{"/auth/email/registration":{"post":{"tags":["auth"],"summary":"Registration","description":"Create user","operationId":"registration_auth_email_registration_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserCreate"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserRead"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/auth/email/token":{"post":{"tags":["auth"],"summary":"Token","description":"Retrieve new access token","operationId":"token_auth_email_token_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserCreate"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessToken"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/users/":{"get":{"tags":["users"],"summary":"Retrieve","description":"Retrieve user","operationId":"retrieve_users__get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserRead"}}}}},"security":[{"APIKeyHeader":[]}]}}},"components":{"schemas":{"AccessToken":{"properties":{"token":{"type":"string","title":"Token","description":"Необходим для запросов к API, действует 24 часа."}},"type":"object","title":"AccessToken"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"UserCreate":{"properties":{"email":{"type":"string","title":"Email"},"password":{"type":"string","title":"Password"}},"type":"object","required":["email","password"],"title":"UserCreate"},"UserRead":{"properties":{"id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Id"},"email":{"type":"string","title":"Email"}},"type":"object","required":["email"],"title":"UserRead"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"securitySchemes":{"APIKeyHeader":{"type":"apiKey","in":"header","name":"access-token"}}}}
0 commit comments