Devo codificare in HTML tutto l'output dalla mia API?

Naviga le tue risposte
6

Sto creando un'API JSON RESTful per accedere ai dati dal nostro sito Web in cui il contenuto è in tedesco.

Una manciata di campi restituirà HTML formattato mentre la maggior parte sono singole righe di testo, anche se sono molto inclini a includere caratteri speciali.

Per renderlo più facile da usare, volevo la coerenza per tutto il tempo. Dato che il testo nei campi HTML non sarebbe facile da codificare dopo che hanno i dati, il mio primo pensiero è stato quello di codificare tutti i campi (possono sempre essere non codificati più tardi in altri campi).

È questo l'approccio migliore o dovrei aggiungere tutti i campi HTML, ad es. description_html per implicare che sono già codificati o provare qualcos'altro?

Il piano prevede che le persone utilizzino l'API come vogliono, sebbene inizialmente consentano ai nostri partner di utilizzare i nostri dati sul loro sito web.

    
posta John 02.11.2011 - 17:15
fonte

2 risposte

8

Generalmente un servizio web dovrebbe restituire dati grezzi e un'applicazione consumante che incorpora i dati in una pagina Web codificherà i dati che incorpora. In questo modo altre applicazioni che potrebbero visualizzare i dati in un'applicazione Windows o eseguire qualche altra elaborazione su di essa non devono occuparsi di html.

Se lo scopo di un servizio è di fornire realmente del testo formattato e usa HTML per rappresentare la formattazione, allora dovrebbe essere contrassegnato come tale. Anche se dovresti considerare come un consumatore di pagine web non utilizzerebbe tali dati.

    
risposta data 02.11.2011 - 18:11
fonte
5

Sembra che ciò dipenda dall'intenzione dell'API. Fornisce HTML formattato ai client o fornisce dati che i client possono utilizzare, a loro avviso?

Se lo scopo è davvero fornire HTML consumabile, direi di fare la codifica. Se deve fornire accesso ai dati, allora non farlo.

Se vuoi davvero supportare entrambi, forse sono diverse API (usando lo stesso codice di back-end) - una delle quali codifica, l'altra no, ma che altrimenti serve gli stessi campi, ecc.

    
risposta data 02.11.2011 - 18:06
fonte

Leggi altre domande sui tag

Log eventi lato server attraverso DB o scrittura su file? Esiste una licenza software GPL compatibile per le librerie che consente il collegamento statico, ma richiede la ridistribuzione del codice sorgente della libreria?