FR

DocsPremiers pas

Qu’est-ce que Nexy ?

Nexy est un framework Python pour les applications Web fullstack : vos pages et votre API vivent dans un seul projet et sont servies par un seul serveur.

Ce que vous obtenez

  • Pages dans Python. Un fichier .nexy est HTML avec quelques lignes de Python en haut ; un fichier .md est aussi une page. Aucun JavaScript n'est nécessaire pour afficher une page.
  • Une API dans le même projet. Un fichier .py sous src/routes/ répond aux requêtes HTTP : une fonction nommée GET répond à GET, une fonction nommée POST répond à POST.
  • Une API dans le même projet. Un contrôleur répond aux requêtes HTTP : sa méthode get répond à GET, sa méthode post répond à POST, et un module regroupe les contrôleurs et leurs services.
  • Une API dans le même projet. Le routeur FastAPI que vous possédez déjà continue de répondre, et les pages et fichiers de route de src/routes/ répondent à côté.
  • Documentation API gratuite. Chaque route API apparaît dans un schéma OpenAPI, et Scalar l'affiche comme référence interactive dans /docs.
  • Formulaires qui appellent Python. Un formulaire, ou un appel tapé depuis le navigateur, atteint la même fonction Python.
  • Un framework frontend quand vous en voulez un. React, Vue, Svelte, Solid ou Preact, pour un composant ou pour l'ensemble du site.
  • Une commande pour fonctionner, une pour expédier. nx dev se recharge au fur et à mesure que vous enregistrez ; nx build prépare la production.

Sur quoi il est construit

La version actuelle, 2.2, repose sur des outils que vous connaissez peut-être déjà :

Partie Construit sur Ce que cela signifie pour vous
Serveur et API FastAPI une route API est une route FastAPI : la validation Pydantic et les dépendances fonctionnent comme d'habitude
Référence API OpenAPI et Scalaire le schéma est à /openapi.json, la référence à /docs
Pages Jinja2 une page .nexy utilise des balises Jinja2 telles que {{ title }}
Frontend (facultatif) Vite uniquement avec un framework frontend, qui nécessite également Node.js

Une première page et un premier point de terminaison

Une page, à /hello :

src/routes/bonjour.nexy
---title: prop[str] = "Hello"---<h1>{{ title }}</h1>

Un point de terminaison, à GET /api/items, répertorié à /docs sans aucun code supplémentaire :

src/routes/api/items.py
from nexy.http import Request  async def GET(request: Request):    return {"items": []}

Une vue et les contrôleurs qui répondent /hello/ et GET /api/items/. Le point de terminaison est répertorié sous /docs sans aucun code supplémentaire, et une URL sans sa dernière barre oblique y redirige :

src/apps/hello_view.nexy
---title: prop[str] = "Hello"---<h1>{{ title }}</h1>
src/apps/hello_controller.py
from nexy.decorators import Controllerfrom nexy.hooks import useViews  @Controller("/hello")class HelloController:    async def get(self):        return useViews("src/apps/hello_view.nexy", context={"title": "Hello"})  @Controller("/api/items")class ItemsController:    async def get(self):        return {"items": []}

Le module racine les répertorie et useRouter = AppModule dans nexyconfig.py le monte :

src/apps/app_module.py
from nexy.decorators import Module from .hello_controller import HelloController, ItemsController  @Module()class AppModule:    controllers = [HelloController, ItemsController]

Ce que Nexy vous laisse

La base de données, le login et les règles sur qui peut faire quoi appartiennent à votre application, vous choisissez donc les bibliothèques. Bases de données et Middleware et sécurité montrent où chacun se connecte.

Prochaines étapes

Modifier sur GitHub

Entrée ouvre le résultat, Échap ferme.