DokuEinheit 1: Die Grundlagen

Erstellen Sie eine Notizen-App mit Nexy, Teil 3: dynamische Routen und eine API

Teil 3 gibt jeder Notiz eine eigene URL, /notes/1, und stellt dieselben Notizen als JSON unter /api/notes bereit, die beide aus einem Python-Modul gelesen werden.

Bevor Sie beginnen: die App von Teil 2.

Bewahren Sie die Notizen in einem Modul auf

Die Seite und die API lesen dieselbe Liste. Verschieben Sie es in ein eigenes Modul mit einer Funktion, die eine Notiz findet:

src/notes.py

NOTES = {1: "Buy milk", 2: "Ship Nexy"}  def find(note_id: int) -> str | None:    return NOTES.get(note_id)

Verknüpfen Sie jede Notiz mit ihrer Seite

src/routes/notes/index.nexy

---from src.notes import NOTES notes = NOTES.items()---<section class="app-page">  <h1>Notes</h1>  <ul>    {% for id, text in notes %}    <li><a href="/notes/{{ id }}">{{ text }}</a></li>    {% endfor %}  </ul></section>

src/apps/notes/notes_view.nexy

---from src.notes import NOTES notes = NOTES.items()---<section class="app-page">  <h1>Notes</h1>  <ul>    {% for id, text in notes %}    <li><a href="/notes/{{ id }}">{{ text }}</a></li>    {% endfor %}  </ul></section>

Fügen Sie eine Seite pro Notiz hinzu

Ein Ordner- oder Dateiname in Klammern ist ein Segment der URL: [id].nexy antwortet auf /notes/1, /notes/2 und übergibt das Segment als Requisite an die Seite. id: prop[int] wandelt es in eine Zahl um, sodass /notes/abc 404 antwortet, bevor die Seite ausgeführt wird.

src/routes/notes/[id].nexy

---from nexy import notFoundfrom src.notes import find id: prop[int]text = find(id)if text is None:    notFound()---<section class="app-page">  <h1>{{ text }}</h1>  <a href="/notes">All notes</a></section>

Ein {id} im Pfad eines Controllers ist ein Segment der URL, das unter diesem Namen an die Methode übergeben wird. id: int wandelt es in eine Zahl um, sodass /notes/abc 404 antwortet, bevor die Methode ausgeführt wird.

src/apps/notes/note_view.nexy

---text: prop[str]---<section class="app-page">  <h1>{{ text }}</h1>  <a href="/notes">All notes</a></section>

notFound() stoppt die Anfrage mit einem 404: Eine Notiz, die nicht existiert, antwortet wie eine URL, die nicht existiert.

Stellen Sie die Notizen als JSON bereit

Eine .py-Datei unter src/routes/ ist eine API-Route. Jede nach einer HTTP-Methode benannte Funktion antwortet auf diese Methode:

src/routes/api/notes.py

from src.notes import NOTES  async def GET():    return [{"id": id, "text": text} for id, text in NOTES.items()]

Die drei Controller der Notizen in einer Datei. Jede nach einer HTTP-Methode benannte Methode antwortet dieser Methode:

src/apps/notes/notes_controller.py

from nexy import notFoundfrom nexy.decorators import Controllerfrom nexy.hooks import useViewsfrom src.notes import NOTES, find LAYOUT = "src/apps/layout.nexy"  def page(view: str, **context: object):    return useViews(LAYOUT, context={"children": useViews(view, context=context)})  @Controller("/notes")class NotesController:    async def get(self):        return page("src/apps/notes/notes_view.nexy")  @Controller("/notes/{id}")class NoteController:    async def get(self, id: int):        text = find(id)        if text is None:            notFound()        return page("src/apps/notes/note_view.nexy", text=text)  @Controller("/api/notes")class NotesApiController:    async def get(self) -> list[dict]:        return [{"id": id, "text": text} for id, text in NOTES.items()]

src/apps/app_module.py

from nexy.decorators import Module from .app_controller import AboutController, AppControllerfrom .notes.notes_controller import NoteController, NotesApiController, NotesController  @Module()class AppModule:    controllers = [AppController, AboutController, NotesController, NoteController, NotesApiController]

Überprüfen Sie die drei URLs:

http://localhost:3000/notes/1 zeigt Milch kaufen;
http://localhost:3000/notes/9 Antworten Seite nicht gefunden;
curl http://localhost:3000/api/notes druckt [{"id":1,"text":"Buy milk"},{"id":2,"text":"Ship Nexy"}].

Die API ist mit ihrem Schema unter http://localhost:3000/docs aufgeführt.

Was du gelernt hast

[id].nexy ist ein dynamisches Segment; id: prop[int] liest und konvertiert es.
Eine .py-Datei unter src/routes/ antwortet JSON, eine Funktion pro HTTP-Methode.

{id} Im Pfad eines Controllers befindet sich ein dynamisches Segment. id: int konvertiert es.
Eine Controller-Methode, die Daten zurückgibt, antwortet JSON; eine, die useViews zurückgibt, beantwortet eine Seite.

notFound() antwortet 404 von überall; Ein gemeinsam genutztes Modul hält Seiten und API im Gleichschritt.

Nächste Schritte

Teil 4: Komponenten
Ausnahmen und Fehler: notFound, redirect und die anderen Exits

Auf GitHub bearbeiten