2015-03-18 17 views
7

Sto sviluppando un'API RESTful quanto più possibile (se il vincolo hateoas non è soddisfatta quindi è non un'API REST per sé)Tipo di contenuto personalizzato: la registrazione con IANA è obbligatoria?

sto versioni API, e poiché ci sono diversi modi per farlo, penso che userò l'intestazione Accept. Conosco le alternative, ma lo scopo di questa domanda non è quello di trovare un modo adeguato per la versione dell'API.

Per quanto ne so, ci sono due modi per la versione API che utilizzano l'intestazione Accept, come si è visto here, here e here:

application/vnd.company.myapp-v1+json 

o utilizzando un qualificatore

application/vnd.company.myapp+json;v=1 

Mentre questo è abbastanza chiaro, ho capito che tutti i tipi di contenuto personalizzato x- sono stati deprecated e vnd. i tipi di contenuto devono essere registrati con IANA.

L'API non è e non sarà pubblica, tutti i client che la utilizzano vengono sviluppati internamente.

È la registrazione di un vnd personalizzato. tipo di contenuto con IANA obbligatorio? Cosa succede se il tipo di contenuto non è registrato? Posso semplicemente usare Accept intestazione application/vnd.company.myapp+json;v=2 anche senza registrarlo con IANA?

Poiché è necessario un tipo di contenuto personalizzato per la negoziazione del contenuto puramente a scopo di controllo delle versioni, è possibile utilizzare qualificatore come application/json;v=2?

risposta

1

Da quello che posso leggere da https://tools.ietf.org/html/rfc6838#section-3.2 non è obbligatorio, tuttavia se avete e API che è pubblico è incoraggiato a farlo.

RFC6838 è sulla registrazione di nuovi tipi MIME/Media, con il seguente testo non sembra essere un problema per l'API private (prodotto)

L'albero del fornitore viene utilizzata per i tipi di supporto associati pubblicamente
prodotti disponibili.

Inoltre non è richiesto per l'API pubblica (prodotto), come ho detto è incoraggiato.

Mentre l'esposizione pubblica e la revisione di tipi di media da registrare nel
l'albero venditore non sono richiesti, utilizzando il [email protected]
mailing list per la revisione è incoraggiato, per migliorare la qualità della
tali specifiche. Le iscrizioni nella struttura vendor possono essere
presentata direttamente alla IANA, dove saranno sottoposti a Expert Review [RFC5226] prima dell'approvazione

Problemi correlati