Informazioni generali

L'ultimo modulo si è concluso con la creazione del primo processo aziendale. Abbiamo capito come creare la logica del processo, accettare parametri di input specifici, eseguire calcoli ed emettere una risposta. Resta da rispondere alla domanda principale. Come attivare il processo aziendale creato e metterlo in funzione?

Per risolvere questo problema, sono previsti degli endpoint, punti chiave di interazione con l'applicazione. Nei primi moduli, abbiamo già interagito con API esterne. Questo è stato possibile grazie alla presenza di endpoint. Sono stati descritti nella documentazione e, leggendola, abbiamo capito quale metodo e quale URL è necessario per inviare una richiesta di accesso a una specifica risorsa.

Per capire, vediamo l'implementazione degli endpoint con un esempio specifico. Nel terzo modulo è stato creato il modello di database. Contemporaneamente alla creazione delle tabelle, sono stati creati automaticamente gli endpoint per interagire con esse. Andiamo nella sezione degli endpoint (nel pannello di sinistra) e osserviamoli.

Nell'esempio della tabella "city", che contiene informazioni sulle città, si può notare che essa dispone già di 6 endpoint per le operazioni di base sui dati.

• GET /city - ottenere tutti i dati da una tabella
• GET /city/:id - ottenere i dati della città con l'id specificato
• POST /city - aggiungere un nuovo record alla tabella
• PUT /city/:id - sostituzione completa del record con l'id specificato nella tabella
• PATCH /city/:id - sostituzione parziale del record con l'id specificato nella tabella
• DELETE /city/:id - eliminazione di un record con l'id specificato dalla tabella

Impostazioni generali

È possibile aprire le impostazioni di ciascun endpoint e studiarlo più in dettaglio. Ad esempio, si consideri l'endpoint GET /city/:id

Il quadro che vediamo è molto simile a quello che abbiamo già visto quando abbiamo creato una richiesta alle API esterne. In un caso, abbiamo avuto accesso solo a un endpoint già pronto, mentre ora lo stiamo creando e configurando noi stessi. Per configurare, occorre specificare

1. Metodo di richiesta. In questo esempio, si tratta del metodo GET.
2. URL di richiesta. La prima parte con il percorso del server non è specificata. È la stessa per tutti gli endpoint dell'applicazione. È sufficiente specificare solo la parte finale (/city). Anche il parametro URL viene specificato qui. L'endpoint è progettato per ricevere informazioni su una particolare città, quindi il suo id scritto dopo ":" viene passato come parametro.
3. Endpoint Groups. Questo parametro non influisce in alcun modo sul funzionamento dell'endpoint ed è inteso solo per comodità dell'organizzazione. Tutti gli endpoint possono essere suddivisi in gruppi tematici (cartelle). In questo esempio, il gruppo "city" contiene tutti gli endpoint per lavorare con i dati sulle città.
4. Business Process. Questo è l'elemento di configurazione più importante e non è visibile in alcun modo quando si invia una richiesta all'endpoint. L'indicazione del processo aziendale determina cosa farà questo endpoint. Allo stesso tempo, l'endpoint stesso può rimanere invariato, riceverà tutte le stesse richieste al vecchio indirizzo, e allo stesso tempo, se il processo di business viene sostituito, svolgerà una funzione completamente diversa. I processi aziendali per le attività di base del database vengono creati automaticamente. Sono chiamati processi aziendali di sistema. Tali BP non possono essere modificati, ma possono essere sostituiti in qualsiasi momento con BP creati in modo indipendente, con processi di business personalizzati.
5. Input/Output variables. Il processo aziendale creato utilizza diverse variabili di ingresso e di uscita, ma l'endpoint non è obbligato a utilizzarle tutte. La parte può essere disabilitata o configurata in modo che endpoint diversi accedano allo stesso BP, con un insieme individuale di variabili. Anche il tipo di richiesta e di risposta (Request / Response type) è configurato qui. Il più delle volte questo tipo sarà JSON, ma, se necessario, si possono usare altre opzioni, come XML o Render File (questo tipo di risposta è usato negli endpoint per lavorare con i file).

Impostazioni del middleware

Le impostazioni generali sono sufficienti per la creazione e l'ulteriore utilizzo dell'endpoint, ma se necessario è possibile utilizzare parametri aggiuntivi. Il più importante di questi è l'attivazione di Middleware con un token Auth.

Il suo utilizzo consente di negare l'accesso a questo endpoint agli utenti che non sono stati autorizzati o che non appartengono a un determinato gruppo (ad esempio, l'accesso può essere concesso solo agli amministratori e negato agli altri utenti).

Impostazioni di registrazione e output

Inoltre, è possibile utilizzare le impostazioni della scheda Settings per registrare in aggiunta le intestazioni o il corpo della richiesta, nonché per nascondere dalla risposta i campi i cui valori non sono impostati.