13

我的这个 API 设计有什么缺陷/有什么优化空间吗?

 3 years ago
source link: https://www.v2ex.com/t/846741
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
neoserver,ios ssh client

V2EX  ›  程序员

我的这个 API 设计有什么缺陷/有什么优化空间吗?

  theklf4 · 26 分钟前 · 196 次点击

因为后端使用 C# + ASP.NET Core 写的,大小写学的是官方 Web API 模板。

POST /api/License/Activate

Example:

  • Request Body:
{
    "productId": 2,
    "productBuildVersion": 45,
    "userHardwareUuid": "659d8d48-d301-4ee1-afdd-c44b958bc948",
    "requestSignature": "e65143a751d32af2ebbc7ffddedf45cbb1b43a20"
}
  • Response Body:

    • Success (HTTP 200):
{
    "result": "success",
    "pgpSignedLicense": "wsFcBAEBCAAQBQJiVnEnCRDWDnwt3C20igAAWG8P/2wZvL5x6ky1KZtf9Mx/\\nUYXFjk84G2BOrm557hxhoz1TixxRR7kQ7nXqi0nkz4iV+D1Fn5mzN5es4Toc\\n/B+gTecXP5Q119FjORGyj5Dy9tWyUc1rVyqmYWwWwpLIM3mFmpfGIek1JjUg\\ngczVsiHWVNOnbeE81iHhfwklN2PHH6ARAepTNnM/PhI173CSkA/Jp/Xpe+CZ\\nRJqZP0GxcT+NuMMivS716Jl96c0HkpNpnrtfU9fLsiWmcxeul3cXKusiti09\\nmudOteT2Jk7Atq1BN9S06BXxNg3zcvRlt9yFUaubgBkvZ/KzPzm3+qO+Djad\\nSDVEICDqZwS+NV2Fo5tiDys43inRjhi3naLjgUIysNuibwkRGJAjCVQij/3X\\nfBOdzm2CW5r7w/QLzot8zqADiZt8Smm7mgbILXY+VqQKHDCm2rME5V6q4GSh\\nBNREbJ6Nif26D+hsTZSzUkEHtp0J4dTcxjzBdiiG7SoHVsS55U0KwiAzfO0x\\nUGrTuGO+iBJ9ii1YYDz+8A5Jy7c5neVhl6KNpJdsZzPkXyIIOKgsNZZDBxOJ\\nf3tpNpIg6TimW0+fej36B17VzLBIuair1RR8lO7aPCe9S6ZnpEugr2nHys4m\\nm4I6wY7AiYHlC3dmYjvcS8GqSs/fytFENJXnLMlbddtSNKIihwI4n1DKG+48\\n4cdx\\n=jkGa",
    "validUntil": 1681368168000
}
  • Fail 0 (HTTP 200):
{
    "result": "general_error",
    "errors": ["reach_max_client_count"]
}
  • Fail 1 (HTTP 400):
{
    "result": "bad_request",
    "errors": ["invalid_user_hardware_uuid"]
}
  • Fail 2 (HTTP 500):
{
    "result": "internal_error"
}

About Joyk


Aggregate valuable and interesting links.
Joyk means Joy of geeK