Domande taggate «api-design»

Il design API (Application Programming Interface) discute le migliori pratiche per la creazione di librerie destinate a scopi generali o per uso pubblico.

6
Cosa hanno in comune le grandi API? [chiuso]
Chiuso . Questa domanda deve essere più focalizzata . Al momento non accetta risposte. Chiuso 6 anni fa . Bloccato . Questa domanda e le sue risposte sono bloccate perché la domanda è fuori tema ma ha un significato storico. Al momento non accetta nuove risposte o interazioni. Cosa c'è …
15 api-design 
1
Qual è il modo corretto di nidificare le risorse nel modello REST?
Sto progettando un'API di servizio REST e mi sono bloccato sul modo corretto di nidificare le risorse. Risorse: partner, biglietti, impostazioni Connessioni tra risorse: il partner ha molti biglietti, il partner ha una serie di impostazioni, Logica aziendale: puoi elencare tutti i partner come utente anonimo, puoi aggiungere un nuovo …
14 api  rest  api-design 
3
Gli ID back-end devono essere pubblici o meno su un'API REST?
Sulla base di ciò che dice questo ragazzo: http://toddfredrich.com/ids-in-rest-api.html Supponiamo che abbia ragione sull'UUID per identificare le risorse API. Quindi ho riscontrato problemi nel tentativo di implementarlo in questo modo, questo è: class FooEntity { final String id = null; //auto-generated by my backend (mongodb), not shared final UUID uid …
4
Usa composizione ed eredità per DTO
Abbiamo un'API Web ASP.NET che fornisce un'API REST per la nostra applicazione a pagina singola. Utilizziamo DTO / POCO per trasferire dati attraverso questa API. Il problema è ora che questi DTO stanno diventando più grandi nel tempo, quindi ora vogliamo riformattare i DTO. Sto cercando "migliori pratiche" su come …
13 rest  api-design  web-api  dto  poco 
1
Quando dovrei usare AtomPub?
Ho condotto alcune ricerche sulla progettazione di servizi Web RESTful e ho raggiunto quello che penso sia un punto di decisione chiave, quindi ho pensato di offrirlo alla comunità per ottenere qualche consiglio. In linea con i principi di un'architettura RESTful, voglio presentare un'API rilevabile, quindi supporterò i vari verbi …
3
JSON piatto o nidificato per dati gerarchici?
Sono passato avanti e indietro ~ 5 volte già. Questo endpoint REST presso /api/tags/sarà per uso interno (nessun client di terze parti), sono l'unico che ci lavora. Sto decidendo tra queste due rappresentazioni: Piatto { "types":[ { "id":1, "text":"Utility" }, { "id":7, "text":"Lease Terms" }, ], "tags":[ { "id":8, "text":"Water", …
12 rest  api-design  json 
2
Devo essere permissivo di parametri sconosciuti?
Sto progettando un'API RESTful e sto affrontando il problema del titolo, ribadito per chiarezza: Devo fallire velocemente se un client invia un parametro non riconosciuto? Per esempio, http://example.com/api/foo?bar=true&paula=bean In quanto sopra, barè un parametro valido ma paulanon è specificato dall'API. Dovrei Avvertire il client dell'errore Fallire velocemente Ignoralo Se avverto …
12 rest  api-design 
1
Mantenere l'API rispetto all'uso dei modi di dire in una porta
Sto lavorando su una porta da Python a Rust e mi sono imbattuto in un codice che non può essere espresso naturalmente in Rust come in Python. Un caso è l'utilizzo dei parametri predefiniti: class Foo: def __init__(self, a="Hello"): self._a = a In Rust, è possibile implementarlo utilizzando un builder: …
2
Progettazione API libreria C ++
Sto cercando una buona risorsa per conoscere una buona progettazione delle API per le librerie C ++, guardare oggetti / dll condivisi ecc. Ci sono molte risorse per scrivere belle API, belle classi, modelli e così via a livello di sorgente, ma a malapena nulla mettere insieme le cose in …
2
Come progettare endpoint API per pubblicare un oggetto figlio e ottenere tutti i figli di tutti i genitori?
Ad esempio ho entità: Cliente, Rapporto. Il cliente può avere molti report e penso che l'endpoint per una singola gestione dei report debba essere nidificato in questo modo: /clients/{client_id}/reports/{report_id} Come per tutti i report di un client, è previsto l'enpoint: /clients/{client_id}/reports Ma come dovrebbe essere un endpoint per ottenere tutti …
12 rest  api  api-design 
Utilizzando il nostro sito, riconosci di aver letto e compreso le nostre Informativa sui cookie e Informativa sulla privacy.
Licensed under cc by-sa 3.0 with attribution required.