Formato della data consigliato per l'API REST GET

Qual è il formato di timestamp consigliato per un'API REST GET come questa:

http://api.example.com/start_date/{timestamp}

Penso che il formato della data effettivo dovrebbe essere il formato ISO 8601, ad esempio YYYY-MM-DDThh:mm:ssZper l'ora UTC.

Dovremmo usare la versione ISO 8601 senza trattini e due punti, come ad esempio:

http://api.example.com/start_date/YYYYMMDDThhmmssZ

o dovremmo codificare il formato ISO 8601, usando ad esempio la codifica base64?

REST non ha un formato di data consigliato. In realtà si riduce a ciò che funziona meglio per l'utente finale e il sistema. Personalmente, vorrei attenermi a uno standard come quello che hai per ISO 8601 (URL codificato).

Se non avendo brutto URI è una preoccupazione (ad esempio, non compresa la versione codificata URL del :, -, in voi URI) e indirizzabilità (umana) non è così importante, si potrebbe anche prendere in considerazione il tempo dell'epoca (ad esempio http://example.com/start/1331162374). L'URL sembra un po 'più pulito, ma sicuramente perdi la leggibilità.

Il /2012/03/07è un altro formato si vede un sacco. Potresti approfondire questo, suppongo. Se segui questa strada, assicurati di essere sempre nell'ora GMT (e chiariscilo nella tua documentazione) o potresti anche voler includere una sorta di indicatore di fuso orario.

In definitiva, si riduce a ciò che funziona per la tua API e il tuo utente finale. La tua API dovrebbe funzionare per te, non per te ;-).

Controlla questo articolo per le 5 leggi di date e orari API QUI :

• Legge # 1: usa ISO-8601 per le tue date
• Legge n. 2: accetta qualsiasi fuso orario
• Legge n. 3: conservalo in UTC
• Legge n. 4: restituirlo in UTC
• Legge # 5: non usare il tempo se non ne hai bisogno

Maggiori informazioni nei documenti.

RFC6690 - Constrained RESTful Environments (CoRE) Formato collegamento Non indica esplicitamente quale formato data dovrebbe essere tuttavia nella sezione 2. Formato collegamento punta a RFC 3986. Ciò implica che la raccomandazione per il tipo di data in RFC 3986 dovrebbe essere utilizzata.

Fondamentalmente RFC 3339 Data e ora su Internet è il documento da guardare che dice:

formato di data e ora per l'utilizzo nei protocolli Internet che è un profilo dello standard ISO 8601 per la rappresentazione di date e ore utilizzando il calendario gregoriano.

a cosa si riduce: AAAA-MM-ggTHH: mm: ss.ss ± hh: mm

(ad esempio 1937-01-01T12: 00: 27.87 + 00: 20)

È la scommessa più sicura.

Ogni campo data / ora in input / output deve essere in formato UNIX / epoch . Ciò evita la confusione tra gli sviluppatori su diversi lati dell'API.

Professionisti:

• Il formato Epoch non ha un fuso orario.
• Epoch ha un unico formato (l'ora Unix è un numero con segno singolo).
• L'ora dell'epoca non viene influenzata dall'ora legale.
• La maggior parte dei framework di backend e tutte le API native ios / android supportano la conversione dell'epoca.
• La parte di conversione dell'ora locale può essere eseguita interamente dal lato dell'applicazione a seconda dell'impostazione del fuso orario del dispositivo / browser dell'utente.

Contro:

• Elaborazione aggiuntiva per la conversione in UTC per l'archiviazione in formato UTC nel database.
• Leggibilità di input / output.
• Leggibilità degli URL GET.

Appunti:

• I fusi orari sono un problema a livello di presentazione! La maggior parte del tuo codice non dovrebbe avere a che fare con i fusi orari o l'ora locale, dovrebbe passare il tempo Unix.
• Se vuoi memorizzare un'ora leggibile dall'uomo (ad esempio i log), considera di memorizzarla insieme all'ora Unix, non al posto dell'ora Unix.

Usa sempre UTC:

Ad esempio, ho un componente di pianificazione che accetta un parametro DATETIME. Quando lo chiamo utilizzando un verbo GET, utilizzo il seguente formato in cui il nome del parametro in arrivo è scheduleDate.

Esempio:
https: // localhost / api / getScheduleForDate? ScheduleDate = 2003-11-21T01: 11: 11Z