{"elements":[{"id":3,"title":"Documentazione","body":"\n
\n
\n

Per Iniziare<\/h2>\n
\n
\n

1. Installa con Composer<\/h4>\n
\n $ <\/span>composer require dressapi\/core\n <\/div>\n <\/div>\n
\n

2. Configura il Database<\/h4>\n
\n
config.php<\/h5>\ndefine<\/span>('DB_HOST'<\/span>, 'localhost'<\/span>);\ndefine<\/span>('DB_NAME'<\/span>, 'your_database'<\/span>);\ndefine<\/span>('DB_USERNAME'<\/span>, 'your_user'<\/span>);\ndefine<\/span>('DB_PASSWORD'<\/span>, 'your_password'<\/span>);\n <\/div>\n <\/div>\n <\/div>\n

Punta il DocumentRoot del web server alla directory www\/<\/code> e la tua API è pronta.<\/p>\n <\/div>\n<\/section>\n\n\n

\n
\n

Autenticazione<\/h2>\n
\n
\n

Login e Ottieni Token JWT<\/h4>\n

Richiesta di Login<\/h5>\n
\ncurl<\/span> -X POST<\/span> https:\/\/api.example.com\/sign \n -d \"dusername=admin&dpassword=admin\"<\/span>\n <\/div>\n
Risposta<\/h5>\n
\n{\n \"token\"<\/span>: \"eyJhbGciOiJIUzI1NiIs...\"<\/span>,\n \"user\"<\/span>: {\n \"id\"<\/span>: 1<\/span>,\n \"username\"<\/span>: \"admin\"<\/span>,\n \"role\"<\/span>: \"admin\"<\/span>\n }\n}\n <\/div>\n <\/div>\n
\n

Usa il Token nelle Richieste<\/h4>\n

Richiesta Autenticata<\/h5>\n
\ncurl<\/span> \n -H \"Authorization: Bearer YOUR_TOKEN\"<\/span> \n -X GET<\/span> https:\/\/api.example.com\/product\n <\/div>\n

Per le pagine HTML, l'autenticazione basata su sessione viene utilizzata automaticamente quando l'header Accept è text\/html<\/code>. Aggiungi site_mode=1<\/code> ai form se necessiti dell'autenticazione via sessione con JSON.<\/p>\n <\/div>\n <\/div>\n <\/div>\n<\/section>\n\n\n

\n
\n

Operazioni CRUD<\/h2>\n
\n \n \n \n \n \n \n \n \n \n \n
Metodo<\/th>\n URL<\/th>\n Descrizione<\/th>\n Esempio<\/th>\n <\/tr>\n <\/thead>\n
GET<\/span><\/td>\n \/table<\/code><\/td>\n Elenco di tutti i record<\/td>\n GET \/product<\/code><\/td>\n <\/tr>\n
GET<\/span><\/td>\n \/table\/id<\/code><\/td>\n Leggi singolo record<\/td>\n GET \/product\/42<\/code><\/td>\n <\/tr>\n
GET<\/span><\/td>\n \/table\/full<\/code><\/td>\n Leggi con relazioni<\/td>\n GET \/product\/full<\/code><\/td>\n <\/tr>\n
POST<\/span><\/td>\n \/table<\/code><\/td>\n Crea record<\/td>\n POST \/product -d \"dname=Shirt\"<\/code><\/td>\n <\/tr>\n
PUT<\/span><\/td>\n \/table\/id<\/code><\/td>\n Aggiorna record<\/td>\n PUT \/product\/42 -d \"dprice=24.99\"<\/code><\/td>\n <\/tr>\n
DELETE<\/span><\/td>\n \/table\/id<\/code><\/td>\n Elimina record<\/td>\n DELETE \/product\/42<\/code><\/td>\n <\/tr>\n <\/tbody>\n <\/table>\n <\/div>\n <\/div>\n<\/section>\n\n\n
\n
\n

Parametri URL<\/h2>\n
\n \n \n \n \n \n \n \n \n \n \n
Parametro<\/th>\n Sintassi<\/th>\n Esempio<\/th>\n Descrizione<\/th>\n <\/tr>\n <\/thead>\n
Con Relazioni<\/td>\n \/full<\/code><\/td>\n \/product\/full<\/code><\/td>\n Include dati dalle tabelle correlate<\/td>\n <\/tr>\n
Paginazione<\/td>\n \/p\/pagina,per_pagina<\/code><\/td>\n \/product\/p\/1,10<\/code><\/td>\n Numero pagina ed elementi per pagina<\/td>\n <\/tr>\n
Ordinamento<\/td>\n \/ob\/campo[-DESC]<\/code><\/td>\n \/product\/ob\/price-DESC<\/code><\/td>\n Ordina per campo, opzionalmente decrescente<\/td>\n <\/tr>\n
Uguale<\/td>\n \/campo=valore<\/code><\/td>\n \/product\/status=active<\/code><\/td>\n Filtro corrispondenza esatta<\/td>\n <\/tr>\n
Contiene<\/td>\n \/campo~valore<\/code><\/td>\n \/product\/name~shirt<\/code><\/td>\n Filtro corrispondenza parziale (LIKE)<\/td>\n <\/tr>\n
Confronto<\/td>\n \/campo>valore<\/code><\/td>\n \/product\/price>10<\/code><\/td>\n Maggiore di, minore di, ecc.<\/td>\n <\/tr>\n <\/tbody>\n <\/table>\n <\/div>\n <\/div>\n<\/section>\n\n\n
\n
\n

Struttura della Risposta<\/h2>\n
\n
\n

Risposta di Successo<\/h4>\n

Risposta JSON<\/h5>\n
\n{\n \"items\"<\/span>: [\n {\n \"id\"<\/span>: 1<\/span>,\n \"name\"<\/span>: \"Blue Shirt\"<\/span>,\n \"price\"<\/span>: 29.99<\/span>,\n \"category\"<\/span>: {\n \"id\"<\/span>: 3<\/span>,\n \"name\"<\/span>: \"Clothing\"<\/span>\n }\n }\n ],\n \"total\"<\/span>: 42<\/span>,\n \"page\"<\/span>: 1<\/span>,\n \"per_page\"<\/span>: 10<\/span>\n}\n <\/div>\n <\/div>\n
\n

Formati di Output<\/h4>\n

Il formato della risposta è determinato dall'header Accept:<\/p>\n

Header Accept<\/h5>\n
\napplication\/json<\/span> # JSON (default)<\/span>\napplication\/xml<\/span> # XML<\/span>\ntext\/html<\/span> # HTML (modalità CMS)<\/span>\ntext\/plain<\/span> # Testo semplice<\/span>\n <\/div>\n <\/div>\n <\/div>\n <\/div>\n<\/section>\n\n\n
\n
\n

Convenzioni Database<\/h2>\n
\n \n \n \n \n \n \n \n \n \n \n \n
Convenzione<\/th>\n Pattern<\/th>\n Esempio<\/th>\n <\/tr>\n <\/thead>\n
Chiave primaria<\/td>\n id<\/code><\/td>\n id INT UNSIGNED AUTO_INCREMENT PRIMARY KEY<\/code><\/td>\n <\/tr>\n
Chiave esterna<\/td>\n id_{tabella}<\/code><\/td>\n id_category INT UNSIGNED<\/code><\/td>\n <\/tr>\n
Tabelle framework<\/td>\n _{nome}<\/code><\/td>\n _user, _role, _acl, _translation<\/code><\/td>\n <\/tr>\n
Campi password<\/td>\n *pwd* \/ *password*<\/code><\/td>\n user_pwd, password<\/code><\/td>\n <\/tr>\n
Campi immagine<\/td>\n *_img<\/code><\/td>\n profile_img, cover_img<\/code><\/td>\n <\/tr>\n
Campi file<\/td>\n *file*<\/code><\/td>\n document_file, filename<\/code><\/td>\n <\/tr>\n
Campi email<\/td>\n *email*<\/code><\/td>\n user_email, email<\/code><\/td>\n <\/tr>\n <\/tbody>\n <\/table>\n <\/div>\n <\/div>\n<\/section>\n\n\n
\n
\n

Documentazione API<\/h2>\n

Documentazione auto-generata dal codice sorgente di DressAPI Core:<\/p>\n

\n \n <\/i> Documentazione API\n <\/a>\n \n <\/i> Codice Sorgente\n <\/a>\n <\/div>\n <\/div>\n<\/section>","description":"Documentazione DressAPI: per iniziare, riferimento API, autenticazione, operazioni CRUD, parametri URL, struttura risposta e convenzioni database.","meta_keywords":"documentation,api reference,rest api,crud,authentication,tutorial","visible":"yes","status":"public","creation_date":"2025-01-01","id__user":1,"priority":0,"groupname":"DOCS"}],"module":"pages","permissions":{"can_read":true},"main_item_title":"title","related_tables":[{"name":"Newsonpage","module":"newsonpage","FK":"id_cmspage","permissions":[]}],"page_info":{"table":"","key":"id","url":"\/pages","url_list":"\/pages","filters":{"id":["=","3"]},"pagination":{"total_items":23,"page":1,"total_pages":2,"step":1,"items_per_page":20,"url_prev":"\/pages","url_next":"\/pages\/p\/2","url_tmpl":"\/pages\/p\/[[p]]","url_tmpl_with_order":"\/pages\/p\/[[p]]\/ob\/[[ob]]"},"order":{"field":"id","type":"DESC","url_tmpl":"\/pages\/p\/[[p]]"},"module":{"title":"Pages","description":"List of pages","name":"pages"},"current":{"title":"Pages","description":"List of pages","name":"pages","url":"\/api-docs"}},"components":{"alert":{"alert1":[{"type":"warning","message":"OK COMPONENT!"},{"type":"danger","message":"ERROR COMPONENT!"}]}},"messages":[]}