Генератор контроллеров FastAPI с правилами написания кода

Содержание

Кому нужен этот промт и как он работает?
Готовый к использованию промт
Как использовать промт и на что обратить внимание
Примеры использования
Пример вывода нейросети
Итог: зачем использовать этот промт?

Кому нужен этот промт и как он работает?

Этот промт предназначен для разработчиков, которые создают контроллеры для веб-приложений на FastAPI. Он помогает быстро и эффективно генерировать код контроллеров по заданным пользовательским требованиям. Благодаря этому промту, можно сэкономить время на рутинное написание кода, получить примеры с мок-данными и комментариями, а также использовать лучшие практики FastAPI и Pydantic.

Промт работает так: вы формулируете задачу по созданию определённого контроллера, а нейросеть создаёт готовый код с учётом заданных правил — исключительно код, без лишних объяснений, с комментариями в стиле Google и мок-данными для имитации ввода-вывода. Это ускоряет разработку и помогает соблюдать стандарты качества и чистоты кода.

Готовый к использованию промт

Ты — разработчик контроллеров для FastAPI. Твоя задача — создавать контроллеры на основе пользовательских запросов. Следуй правилам при написании кода:

1. Отвечай только кодом.

2. Используй мок-данные для операций ввода-вывода.

3. Пиши комментарии в стиле Google.

4. Используй модели Pydantic.

5. Пиши чистый и эффективный код.

6. Используй максимально возможности FastAPI.

7. Минимизируй использование токенов в ответе.

Если правила понятны, ответь «FastAPI builder initialised».

Как использовать промт и на что обратить внимание

Используйте этот промт, когда нужно получить шаблон контроллера для FastAPI без лишних объяснений. Чёткое формулирование задачи позволит получить максимально релевантный и лаконичный код. Промт подойдёт как для новичков, так и для опытных разработчиков, которые хотят ускорить написание стандартных контроллеров.

Рекомендуется уточнять в пользовательском запросе, какую конкретно функциональность должен реализовывать контроллер, чтобы получить максимально точный код. Также важно помнить, что в ответе используются мок-данные — это значит, что функции имитируют операции с данными, а не работают с реальной базой.

Возможные ограничения:

Промт создаёт только код контроллеров, без бизнес-логики или реальных операций с базой.
Ответы могут содержать упрощённые примеры из-за минимизации токенов.
Для сложных сценариев может потребоваться доработка и интеграция полученного кода вручную.

Примеры использования

Ниже представлены два примера запросов к нейросети с этим промтом, которые помогут получить код для разных задач.

Пример 1: контроллер для получения списка пользователей с пагинацией

1	Создай GET контроллер /users, который возвращает список пользователей с параметрами page и size для пагинации.

Пример 2: контроллер для создания новой статьи с проверкой данных

1	Создай POST контроллер /articles, который принимает данные статьи (title, content) и возвращает созданную статью с ID.

Пример вывода нейросети

Ниже представлен пример реального ответа нейросети на запрос из Примера 1.

✅ Example:

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
32
33
34
35

from fastapi import APIRouter, Query
from pydantic import BaseModel
from typing import List

router = APIRouter()

class User(BaseModel):
    """Pydantic модель для пользователя."""
    id: int
    name: str
    email: str

# Мок-список пользователей
mock_users = [
    {"id": 1, "name": "Иван", "email": "ivan@example.com"},
    {"id": 2, "name": "Ольга", "email": "olga@example.com"},
    {"id": 3, "name": "Пётр", "email": "petr@example.com"},
]

@router.get("/users", response_model=List[User])
async def get_users(page: int = Query(1, ge=1), size: int = Query(10, ge=1, le=50)):
    """
    Получить список пользователей с пагинацией.

    Args:
        page (int): Номер страницы, начиная с 1.
        size (int): Количество пользователей на странице.

    Returns:
        List[User]: Срез списка пользователей.
    """
    start = (page - 1) * size
    end = start + size
    return mock_users[start:end]

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

Итог: зачем использовать этот промт?

Этот промт позволяет быстро и лаконично получить рабочий код контроллеров для FastAPI с соблюдением лучших практик и с мок-данными. Вы экономите время на подготовку шаблонов, получаете понятные и комментированные примеры, что особенно полезно при разработке и обучении.