Web API Design | Pluralsight

Web API Design | Pluralsight



Web API Summary

=================

>> RESTful

- Resource based as URIs

- http verbs for operations

- heirarchical web data e.g. Customers/1/orders

- stateless

- Client and Server are fully separate i.e. there is no references or proxies other than the URI

- Requests are cacheable

- Hateos or hypermedia i.e the results are self documenting e.g. it includes links or uri for the other operations that can be valid on result

- Content negociation based on headers



>> Good Desing

- should be url based and using plural nouns

- should use HTTP verbs to perform operations

- should return http status codes for delete, updated item for Put, all items for Get

- ETag caching

- Paging

- Versioning