apisyouwonthate / apisyouwonthate/book-build-apis-2

Improve Content: Returning response data

Aperta
#63 0 commenti 0 reazioni 1 assegnatario Rivendicata da @AlexanderKaran Vedi su GitHub
Lingua principale
Ruby
Stelle
248
Fork
24
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

**The Importance of Naming Things Good**

One from the Slack community:

> Pradeep: One of my coworkers just posted a sample API response from a vendor that we're integrating with.  Enjoy.

```
{
"DataList": [
{
"Parameter": 74277,
"Parameter Label": "TC3 IO; Omni Sensor Setup Program GH1C; OmniSensor Substrate Temperature",
"DataSet": [
{
"Data": "37.30 °C",
"Time": "Tue Aug 24 15:47:47 2021"
}
]
}
]
}
```

Pradeep  3 days ago
But even more interesting is
37.30 °C is called Data not Temperature
And the value of Tue Aug 24 15:47:47 2021 is being referred to as Time even though it has a date component

One of my pet-peeves when reviewing openapi specs is when people name things badly - or even worse with abbreviations that only they know

Sid Maestre  3 days ago
This should be included in API design books & courses with the prompt ... how would you improve this API response?

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.