apisyouwonthate / apisyouwonthate/book-build-apis-2
Improve Content: Returning response data
- 主要语言
- Ruby
- 星标
- 248
- 派生
- 24
- PR 合并指标
- 30 天内没有已合并 PR
描述
**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?
贡献指南
这个仓库没有索引到贡献指南
评估
这个 Issue 还没有评估数据。