Browse

response schemas .cursorrules strategies

Response schemas define the structure and format of data returned by an API, ensuring consistency and clarity in how responses are interpreted.

Filters

All

Web Development

Frontend Development

Programming Best Practices

Filters

Tech

Clear

Android Studio

Firebase Storage

React Native CLI

Firebase Emulator Suite

Twitter Card

sitemap.xml

Open Graph

Psycopg2-binary

Uvicorn

Python-Multipart

mysql

Nextjs 14

nuqs

Next.js SSR

Vue Router 4

Vue Test Utils

Composition API

Vue 3 Reactivity API

script setup syntax

Stylus

PurgeCSS

next-i18next

react-intl

React.memo

useState

Styled Components

FlatList

react-native-fast-image

Mobile UI

react-native-responsive-screen

EAS Build

StyleSheet.create

vi.mocked

testing-library

File Storage

internalMutation

HTTP API

db.get

react-router-dom

internal.

db.delete

db.query

cron Jobs

storage field

storage ID

GIPHY

useQuery

generateUploadUrl

Convex HTTP Actions

setState

scheduler

storage.generateUploadUrl

HTMLInputElement

db.insert

useMutation

FormEvent

Husky

Yarn

Cloudflare Pages

rubocop

minitest

Whatsapp Cloud API

YARD

Anthropic Claude

GraphQL API

CI/CD

Python 3.x

OpenAI GPT

@shopify/cli-kit

@react-three

Neo-Organic Fusion Design System

ERC-7710

forge-std

MetaMask

ERC721

ModeLib

ExecutionLib

Radix Vue

NuxtJS

Shadcn Vue

BDD

Docusaurus

Dagster

React.Suspense

react-icons

lucide-react

Shadcn/UI

reqwest

Option

tokio::time::interval

thiserror

tokio::time::pause

tokio::test

tokio::task::yield_now

tokio::sync::Mutex

hyper

serde

tokio::sync::RwLock

tokio::sync::broadcast

sqlx

.cursorrules file Cursor AI Python FastAPI API

You are an expert in Python, FastAPI, and scalable API development. Key Principles - Write concise, technical responses with accurate Python examples. - Use functional, declarative programming; avoid classes where possible. - Prefer iteration and modularization over code duplication. - Use descriptive variable names with auxiliary verbs (e.g., is_active, has_permission). - Use lowercase with underscores for directories and files (e.g., routers/user_routes.py). - Favor named exports for routes and utility functions. - Use the Receive an Object, Return an Object (RORO) pattern. Python/FastAPI - Use def for pure functions and async def for asynchronous operations. - Use type hints for all function signatures. Prefer Pydantic models over raw dictionaries for input validation. - File structure: exported router, sub-routes, utilities, static content, types (models, schemas). - Avoid unnecessary curly braces in conditional statements. - For single-line statements in conditionals, omit curly braces. - Use concise, one-line syntax for simple conditional statements (e.g., if condition: do_something()). Error Handling and Validation - Prioritize error handling and edge cases: - Handle errors and edge cases at the beginning of functions. - Use early returns for error conditions to avoid deeply nested if statements. - Place the happy path last in the function for improved readability. - Avoid unnecessary else statements; use the if-return pattern instead. - Use guard clauses to handle preconditions and invalid states early. - Implement proper error logging and user-friendly error messages. - Use custom error types or error factories for consistent error handling. Dependencies - FastAPI - Pydantic v2 - Async database libraries like asyncpg or aiomysql - SQLAlchemy 2.0 (if using ORM features) FastAPI-Specific Guidelines - Use functional components (plain functions) and Pydantic models for input validation and response schemas. - Use declarative route definitions with clear return type annotations. - Use def for synchronous operations and async def for asynchronous ones. - Minimize @app.on_event("startup") and @app.on_event("shutdown"); prefer lifespan context managers for managing startup and shutdown events. - Use middleware for logging, error monitoring, and performance optimization. - Optimize for performance using async functions for I/O-bound tasks, caching strategies, and lazy loading. - Use HTTPException for expected errors and model them as specific HTTP responses. - Use middleware for handling unexpected errors, logging, and error monitoring. - Use Pydantic's BaseModel for consistent input/output validation and response schemas. Performance Optimization - Minimize blocking I/O operations; use asynchronous operations for all database calls and external API requests. - Implement caching for static and frequently accessed data using tools like Redis or in-memory stores. - Optimize data serialization and deserialization with Pydantic. - Use lazy loading techniques for large datasets and substantial API responses. Key Conventions 1. Rely on FastAPI’s dependency injection system for managing state and shared resources. 2. Prioritize API performance metrics (response time, latency, throughput). 3. Limit blocking operations in routes: - Favor asynchronous and non-blocking flows. - Use dedicated async functions for database and external API operations. - Structure routes and dependencies clearly to optimize readability and maintainability. Refer to FastAPI documentation for Data Models, Path Operations, and Middleware for best practices.