Registrierungsformulare: Speichere dein Formular als Spec
Automatisch aus dem Englischen übersetzt.
Auf Englisch lesenEine Spec für ein Registrierungsformular beschreibt, was dein Formular abfragt, Bildschirm für Bildschirm: den Abschnitt jedes Felds aus dem Feldkatalog, sein Label, ob es Pflicht ist, und seine Test-ID. Erstelle eine in der App oder mit deinem Coding-Agent aus deiner Beschreibung oder einem Screenshot deines Formulars und speichere sie im Projekt. Beim Speichern werden die Custom Fields genutzt, die ihre Felder schon füllen, und die nötigen angelegt, wo keins existiert, sodass form_values jedes Feld füllt, das es sicher füllen kann, und den Rest deinem Test überlässt.
Ein Projekt speichert bis zu 20 Registrierungsformulare.
Mit deinem Agent erstellen
Abschnitt betitelt „Mit deinem Agent erstellen“Bitte deinen Agent, den Prompt build_signup_form_from_screenshot auszuführen, und teile dann einen Screenshot jedes Screens deines Formulars. Er liest die Felder, zeigt dir die Spec als Tabelle zum Korrigieren und speichert sie erst, wenn du zustimmst.
Die Screenshots bleiben bei deinem Agent: Nur die Spec, der du zustimmst, wird an Proxy Mail QA gesendet.
Du kannst das Formular auch beschreiben: „E-Mail, Passwort, Unternehmensgröße und die AGB-Box, dann ein zweiter Screen mit deiner Rolle“.
In der App erstellen
Abschnitt betitelt „In der App erstellen“Öffne Project settings → Forms und wähle Neues Formular. Beginne mit einer Vorlage oder einem leeren Formular, dann:
- Füge jedem Screen Felder aus dem Katalog hinzu, ändere ihre Labels und markiere sie als Pflicht oder nicht
- Lege die Optionen eines Felds über seinen Options-Button fest: Länge des Passworts und benötigte Zeichen, ein Mindestalter, ein Land oder die Auswahl eines Drop-downs
- Füge Screens hinzu, jeweils mit Überschrift und Seitenpfad
- Sieh es unter Vorschau, den Code unter Code und die Tests unter Test, jeweils mit Kopieren
Leer gelassene Labels folgen der Sprache des Formulars. Jedes Feld zeigt, wie es gefüllt wird: von Proxy Mail QA, von einem fertigen Custom Field oder von deinem Test. Sobald das Formular gespeichert ist, nennt ein Feld, das von einem Custom Field gefüllt wird, dieses, mit Open, um es in Project settings → Custom fields aufzurufen, und zeigt an, wenn das Custom Field aus ist. Ein Feld, das eines deiner Standardfelder abschaltet, sagt das, mit einem Button dorthin. Ein Feld für Telefon, ID oder Steuernummer, eine Auswahl oder die AGB-Box wird von einem fertigen Feld gefüllt: dem, das das Formular anlegt, dem, das zu seiner Test-ID passt, oder dem eigenen des Projekts für diese Feldart. Ein Telefonfeld zeigt an, wann dein Test es eintippt: Die Telefonnummer des Projekts setzt eine für Fiktion reservierte Nummer in Großbritannien, Australien, den USA und Kanada ein oder die Testnummer deiner App für ein anderes Land und lässt es leer für ein Land ohne beides.
Unter Custom Fields hat jedes Custom Field, das ein Formular erstellt hat, ein Von-Tag mit dem Namen des Formulars, das das Formular öffnet. Ein eigenes, das ein Formular unverändert nutzt, hat ein Genutzt von-Tag.
Formulare und deine Custom Fields
Abschnitt betitelt „Formulare und deine Custom Fields“Ein Formular beschreibt deine Registrierungsseite: Screens, Felder, Labels und Test-IDs, für Code, Tests und Vorschau. Custom Fields entscheiden bei jedem Ausfüllen, was in ein Feld kommt, ob es ein Formular gibt oder nicht. Ein Formular braucht nie ein zweites Custom Field für dasselbe Feld:
- Es nutzt, was da ist. Wo eines deiner Custom Fields ein Feld bereits füllt, etwa die fertige Telefonnummer des Projekts oder deine eigene Regel für eine Frage zur Unternehmensgröße, wird es beim Speichern genutzt. Ein fertiges wird nur erstellt, wo nichts das Feld füllt.
- Es übergeht deines nie stillschweigend. Wenn ein fertiges Feld des Formulars Vorrang vor einem deiner eigenen Custom Fields hat (etwa weil du deine Regel nach dem Speichern hinzugefügt hast), sagt das Formular das über seinen Feldern und am Feld: Deins behalten entfernt das des Formulars beim Speichern; Das des Formulars nutzen behält das des Formulars und fragt nicht erneut. Unter Custom Fields hat dein Feld ein Konflikt mit-Tag, das das Formular an diesem Feld öffnet.
- Speichern räumt auf. Wenn das Formular ein selbst erstelltes Custom Field nicht mehr nutzt, weil du sein Feld entfernt, seine Test-ID geändert oder deins gewählt hast, fragt das Speichern zuerst: auf die neue Test-ID verschieben, entfernen oder behalten. Wo nur Leads Custom Fields ändern, bittet ein Mitglied die Leads, es zu entfernen.
Dein Agent macht dasselbe mit save_signup_form: fields_filled_by in der Antwort sagt, was jedes Feld füllt, und clashes und leftovers warten auf deine Entscheidung. Dein Agent fragt dich und speichert dann erneut mit choices oder tidy. Bis dahin wird nichts entfernt.
Eine Frage, die dein Custom Field beantwortet
Abschnitt betitelt „Eine Frage, die dein Custom Field beantwortet“Für eine eigene Frage, die eines deiner Custom Fields bereits beantwortet, etwa wie viele Plätze ein Team braucht, füge sie über Add a field → Your custom fields hinzu. Das Formular übernimmt das Feld in Code, Tests und Vorschau; dein Custom Field entscheidet weiterhin bei jedem Ausfüllen, was hineinkommt. Das Feld übernimmt den Namen des Custom Fields und, wo das Custom Field Felder per Test-ID findet, diese Test-ID; wähle, ob es ein Textfeld, ein Drop-down oder eine Checkbox ist. Das Feld zeigt, ob dein Custom Field es findet, und wenn ein neues Label oder eine neue Test-ID das verhindert, wonach das Custom Field sucht.
Dein Agent fügt eines mit Abschnitt custom, der ID des Custom Fields aus list_custom_fields, einem Label und options.type hinzu; finds in fields_filled_by sagt, ob das Custom Field es findet. Ein fertiges Feld wird nicht so hinzugefügt: Nutze den eigenen Abschnitt seines Felds.
Hast du Screenshots? Prompt kopieren liefert eine Zeile, die du mit ihnen in deinen Coding-Agent einfügst: Dein Agent liest sie, und sie kommen nie zu Proxy Mail QA. Öffnen in öffnet Qoder, Cursor, VS Code (1.140 oder neuer) oder Claude mit der bereits eingetippten Zeile: Füge dort deine Screenshots hinzu und sende sie ab. Bis dahin wird nichts gesendet. Wenn du Proxy Mail QA aus einem davon mit diesem Projekt verbunden hast, bekommt es einen eigenen Button, etwa In Qoder öffnen.
Vorlagen
Abschnitt betitelt „Vorlagen“Starte mit einer von acht Specs statt mit einem leeren Formular. Dein Agent listet sie mit list_signup_starters, und Neues Formular in der App bietet sie an.
| Vorlage | Was sie abfragt |
|---|---|
b2c |
Eine Consumer-App: Name, E-Mail, Passwort, Geburtsdatum, die AGB und eine optionale Marketing-Box |
b2b |
B2B-SaaS: zuerst ein Konto, dann Name, Website, Rolle, Teamgröße, Land, USt-IdNr. und Handelsregisternummer des Unternehmens |
education |
Eine neutrale Altersfrage (das Geburtsdatum, nicht „Bist du über 13?“) und die E-Mail eines Elternteils für jüngere Lernende |
marketplace |
Ein Verkäuferkonto, dann das Unternehmen: Art, Land, Adresse, Geburtsdatum, Steuernummer und Auszahlungskonto |
travel |
Die Passagierdaten, die Airlines vorab senden (APIS), mit einem Reisepass von Utopia, dem fiktiven Staat der ICAO, und dessen Ablaufdatum |
fintech |
Was eine Identitätsprüfung für die USA braucht: gesetzlicher Name, Geburtsdatum, Telefon, Adresse und eine nationale ID-Nummer |
japan |
Ein japanisches Formular: zuerst der Familienname, die Lesung in Katakana, dann E-Mail, Passwort, Geburtsdatum, Telefon und Adresse |
china |
Ein chinesisches Formular: zuerst das Telefon, dann Passwort, vollständiger Name und die Personalausweisnummer für die Klarnamenpflicht |
Jede kommt mit Hinweisen, etwa wo Buttons für die Anmeldung mit Google oder LINE hingehören (sie sind keine Felder) und welche Werte aus dem Testmodus eines Zahlungsanbieters stammen. Fordere eine in einer anderen Sprache oder für ein anderes Land an, und Labels, Drop-downs und ID-Formate passen sich an. Nichts wird gespeichert, bis du deine Version speicherst.
Kombiniere für ein Fintech-Formular die Vorlage mit dem KYC-Sandbox-Modus: form_values mit kyc_sandbox liefert die eigenen Sandbox-Werte eines Anbieters (Stripe, Plaid, Onfido, Veriff, Didit, Cashfree oder Setu) für ein Bestehen, ein Scheitern oder eine Prüfung, und die neu erstellte Adresse übernimmt die Namen und das Geburtsdatum des Anbieters. Proxy Mail QA prüft nie eine Identität: Die Werte passen nur zu dem, was die Sandbox jedes Anbieters erwartet. Siehe Feldformate nach Land.
Was eine Spec enthält
Abschnitt betitelt „Was eine Spec enthält“{ "name": "Main sign-up", "site": "https://staging.example.com/*", "language": "en", "screens": [ { "path": "/signup", "fields": [ { "section": "email" }, { "section": "password", "options": { "min_length": 12, "classes": ["upper", "digit"] } }, { "section": "business.team_size", "options": { "choices": ["1-10", "11-50", "51-200"] } }, { "section": "consent.terms" } ] } ]}| Teil | Was er angibt |
|---|---|
name |
Wie das Formular heißt. Speichern eines Formulars mit demselben Namen ändert es |
site |
Die Website, auf der es ist, wie das Projekt sie listet. Lass sie weg, damit die Felder des Formulars auf jeder Website passen |
language |
Die Sprache des Formulars, für seine Standard-Labels: en, de, fr, es, it, pt, nl, zh oder ja |
country |
Ein zweistelliger Ländercode für Felder, die davon abhängen: IDs, USt-IdNrn., Telefonnummern und Adressen |
screens |
Bis zu 10 Screens in Reihenfolge, jeweils mit optionalem title, path und bis zu 30 Feldern; insgesamt 60 Felder |
| Ein Feld | Sein section, required (true, sofern du nichts anderes angibst), label, testid und options; jeder Abschnitt einmal |
Die Beschriftung eines Felds ist standardmäßig die Beschriftung seines Abschnitts in der Sprache des Formulars, und seine Test-ID ist standardmäßig signup- und die Abschnitts-ID mit Bindestrichen, etwa signup-business-team-size.
Ein Feld mit dem Abschnitt custom nennt stattdessen eines deiner benutzerdefinierten Felder, etwa { "section": "custom", "custom_field": "<its id>", "label": "Seats", "options": { "type": "select", "choices": ["1-5", "6-20"] } }. Es braucht eine Beschriftung, und seine Test-ID ist standardmäßig signup- und die Beschriftung mit Bindestrichen, etwa signup-seats.
Optionen gibt es nur für die Abschnitte, die sie annehmen: min_length, max_length und classes (lower, upper, digit, symbol) für ein Passwort, min_age für ein Geburtsdatum, country für ein länderabhängiges Feld und choices für ein Drop-down oder eine Radio-Gruppe.
Wie jedes Feld ausgefüllt wird
Abschnitt betitelt „Wie jedes Feld ausgefüllt wird“get_signup_form und GET /v1/project/signup-forms/{id} sagen, woher jedes Feld seinen Wert bekommt:
| Ausfüllen | Bedeutung |
|---|---|
built_in |
form_values und Proxy Mail QA for Chrome füllen es aus der Testperson: Namen, E-Mail, Passwort |
custom_field |
Ein benutzerdefiniertes Feld füllt es: ein fertiges oder, beim Abschnitt custom, das, das das Feld nennt |
never |
Proxy Mail QA überlässt es deinem Test |
Nur die custom_field-Abschnitte bekommen ein benutzerdefiniertes Feld, und zwar ein fertiges: Telefon-, Ausweis- und Steuernummern, Geschlecht, Sprache, wie jemand von euch erfahren hat, Rolle, Teamgröße, Unternehmensart und das Kästchen für die Bedingungen. Ein Formular nutzt die eigenen fertigen Felder des Projekts, wo es sie gibt, etwa die Ausweis- und Steuernummernfelder, die ein Lead in Project settings → Custom fields hinzufügt, oder alle fünf auf einmal mit fill_id_fields von update_project. Jedes Feld, das ein Formular anlegt, findet sein Feld über die Test-ID, also füge diese data-testid-Attribute zu deinem Formular hinzu. Wenn du ein Formular entfernst, bleiben seine benutzerdefinierten Felder, außer du willst, dass sie auch gehen: In der App ist Auch die benutzerdefinierten Felder entfernen, die es angelegt hat im Dialog „Entfernen“ angehakt; Agents und die API senden remove_custom_fields. Ein benutzerdefiniertes Feld, das ein anderes Formular noch nutzt, bleibt. Wo nur Leads benutzerdefinierte Felder ändern, bittet das Entfernen durch ein Mitglied stattdessen die Leads, sie zu entfernen (Die Leads auch bitten, die benutzerdefinierten Felder zu entfernen, die es angelegt hat), mit einer Anfrage pro Feld, die sie in Project settings → Custom fields beantworten. Sonst bleibt ein benutzerdefiniertes Feld, das jemand anderes hinzugefügt hat.
Als Code holen
Abschnitt betitelt „Als Code holen“Dein Agent kann ein gespeichertes Formular mit get_signup_form_code in Code für deine App umwandeln, in einer von drei Arten:
| Format | Was du bekommst |
|---|---|
react-hook-form |
Eine React-Komponente mit react-hook-form und einem zod-Schema (Standard) |
react |
Eine React-Komponente mit einfachem State und ohne weitere Pakete |
html |
Eine HTML-Seite mit eigenem Skript |
Jedes Feld prüft, was die Spezifikation verlangt: die Regeln des Passworts, das Alter bei einem Geburtsdatum sowie Format und Prüfziffer einer Ausweis- oder USt-IdNr. für ihr Land. Meldungen und Buttons sind in der Sprache des Formulars. Bildschirme kommen nacheinander, mit Weiter und Zurück. Jedes Feld behält sein data-testid, damit die benutzerdefinierten Felder des Formulars es finden.
Die Ausweisprüfungen laufen im Browser, um Menschen beim Tippen zu helfen. Prüfe sie auch auf deinem Server.
Dein Agent passt den Code an deine App an: deine Komponenten und Styles, mit den Test-IDs und Regeln unverändert. Die notes der Antwort sagen, was du dir ansehen solltest, etwa ein Drop-down, das noch unsere üblichen Antworten anbietet.
Tests dafür holen
Abschnitt betitelt „Tests dafür holen“get_signup_form_test liefert Tests für ein gespeichertes Formular, für Playwright (Standard) oder Cypress. Jedes Feld bekommt Werte, die das Formular annehmen soll, und Werte, die es ablehnen soll, einzeln, während alle anderen Felder korrekt ausgefüllt sind:
- Leer gelassen, wenn das Feld Pflicht ist
- Eine E-Mail-Adresse ohne @ oder ohne Punkt danach
- Ein Passwort, das ein Zeichen zu kurz ist, und eines ohne jede Zeichenart, die die Spezifikation verlangt
- Ein Geburtsdatum für jemanden, der morgen das Mindestalter erreicht, und eines für jemanden, der es heute erreicht hat
- Eine Ausweis- oder USt-IdNr. mit falscher Prüfziffer, einem Zeichen zu wenig oder einem Buchstaben, wo eine Ziffer hingehört
- Namen mit Akzenten und Apostrophen sowie anders geschriebene Telefonnummern, die das Formular annehmen soll
Die Tests legen vor dem Start eine Testadresse mit Persona und Passwort an und löschen sie danach. Sie finden jedes Feld über das data-testid, das der Code-Export schreibt, und erwarten, dass eine Ablehnung als <test id>-error-Meldung des Felds oder als aria-invalid="true" erscheint. Setze SIGNUP_URL auf die Seite des Formulars. Wenn dein Formular nicht aus dem Code-Export stammt, prüfe, ob seine Test-IDs und Fehlermeldungen passen, oder ändere die Helfer des Tests.
Ein Feld, für das Proxy Mail QA keinen Wert liefert, etwa eine USt-IdNr., wird in notes genannt: Trag einen Wert, den dein Formular annimmt, in valid() des Tests ein.
Bei einem gesperrten Projekt
Abschnitt betitelt „Bei einem gesperrten Projekt“Wo nur Leads benutzerdefinierte Felder ändern, geht das Speichern eines Mitglieds, in der App oder durch seinen Agent, als eine Anfrage für das ganze Formular an die Leads. In der App heißt der Button Leads fragen. Das Formular wartet als Entwurf, der sich weiter lesen und ändern lässt. Ein Lead genehmigt oder lehnt ihn in Project settings → Custom fields ab; eine Genehmigung speichert das Formular und legt zugleich seine benutzerdefinierten Felder an.
In der API
Abschnitt betitelt „In der API“| Wo | Was |
|---|---|
| MCP | list_signup_starters, list_signup_forms, get_signup_form, save_signup_form, delete_signup_form, get_signup_form_code, get_signup_form_test |
| REST API | GET /v1/signup-starters, GET und POST /v1/project/signup-forms, GET und DELETE /v1/project/signup-forms/{id}, GET /v1/project/signup-forms/{id}/code und /test |
| npm | signupStarters({ id?, language?, country? }), signupForms(), signupForm(id), saveSignupForm(spec, id?), deleteSignupForm(id, { removeCustomFields? }), signupFormCode(id, { format?, requested? }), signupFormTest(id, { framework? }) |
| Python | list_signup_starters(starter_id=None), list_signup_forms(), get_signup_form(form_id), save_signup_form(spec, form_id=None), delete_signup_form(form_id, remove_custom_fields=False), signup_form_code(form_id, format=...), signup_form_test(form_id, framework=...) |
Eine Frage zu dieser Seite?
Frag in jeder Sprache. Die Doku kann dir sofort antworten oder deine Frage an das Team von Proxy Mail QA schicken, das auf Englisch antwortet.