Ingegneria software api

5

Quando un'API è considerata un DSL incorporato?

Qual è la differenza tra un'API e un linguaggio specifico di dominio incorporato (DSL)? È solo sintassi? Prendi in considerazione un'API come OpenGL. In cosa differisce da una DSL grafica? In altre parole, se un'API è sufficientemente complessa, può essere considerata una DSL integrata?

10 api dsl

3

È una cattiva pratica per una definizione di oggetto API contenere ID di riferimento di terze parti come proprietà?

Come questo: Campaign: type: object properties: id: type: string description: "A GUID identifier" referenceId: type: string description: "A consumers identifier they have used to map their own systems logic to this object." name: type: string description: "'Great Campaign 2017' as an example" Sono preoccupato per il riferimentoId . Il dominio …

9 rest api domain-driven-design api-design single-responsibility

2

Aggiunta a un set finito di opzioni; un cambiamento di rottura dell'API?

Prendi un endpoint API HTTP che sputa il seguente modello di risposta: { "type": "Dog", "name": "Jessi", ... } Il typecampo è stato descritto nella documentazione come uno dei Dog, Cato di Fish. L'aggiunta di una nuova opzione, per esempio Rat, sarebbe considerata una rottura dell'API? L'aggiunta di un'opzione a …

9 rest api api-design json

3

Nel linguaggio REST qual è la differenza tra una risorsa e una rappresentazione?

La mia comprensione di REST che consente di modellare le operazioni di servizio come rappresentazione di stato e transizione da uno stato a un altro utilizzando HTTP. Ho sempre compreso le risorse come rappresentazioni dello stato lato servizio fino a poco tempo fa quando ho letto questo articolo di Jimmy …

9 rest api api-design

2

Avvisi in un'API REST come errori non critici

Ho un'API REST che per alcune entpoind come DELETE, POST o PUT ho alcune regole di convalida che possono restituire un errore. Ora ho bisogno di un nuovo tipo di errore come un errore non critico, che dovrebbe fallire in modo normale, ma dovrebbe andare per l'azione in caso di …

9 rest api

3

API CRUD: come specificare quali campi aggiornare?

Supponiamo che tu abbia un qualche tipo di struttura di dati, che è persistente in un qualche tipo di database. Per semplicità, chiamiamo questa struttura di dati Person. Ora ti viene assegnato il compito di progettare un'API CRUD, che consente ad altre applicazioni di creare, leggere, aggiornare ed eliminare messaggi …

9 design api web-services api-design crud

3

sta usando un PUT con effetti collaterali accettabili (REST)

Voglio creare una cronologia degli annullamenti ogni volta che l'utente aggiorna un modulo. Perché è un aggiornamento, voglio usare una richiesta PUT. Tuttavia, ho letto che il PUT non deve avere effetti collaterali . È accettabile usare PUT qui? Ci sono alternative migliori? PUT /person/F02E395A235 { time: 1234567, fields: { …

9 language-agnostic api rest

Domande taggate «api»