Naming conventions

It is not recommended to use verbs in the URL, the resource names should be based on nouns:

Example Microsoft:

POST https://adventure-works.com/orders // Good
POST https://adventure-works.com/create-order // Avoid

Summary, the following Queries in airs-bp3:

POST .../IssueLinkDeviceToken
POST .../GetSalesMetrics

violates Restful API design:

  • uses POST for query, without changing the server state

  • uses verb in the URL

Should be:

GET .../TokenToLinkDevice?args=...
GET .../SalesMetrics?args=...

Last updated

Was this helpful?