Transcription of ASP.NET Core Web API Best Practices
{{id}} {{{paragraph}}}
Core Web API Best PracticesS T E V E S M I T HA R D A L I S .C O M | @ A R D A L I S | S T E V E @ A R D A L I S .C O MW E E K LY D E V T I P S .C O M ( P O D C A S T )Web API Best Practices -@ardalisLearn More After Today1) DevIQ Core Quick ) Microsoft FREE eBook/Sample App ) Weekly Dev Tips Podcast / Newsletter ) Contact me for mentoring/training for your company/team API Best Practices -@ardalisWeb API DesignWeb API Best Practices -@ardalisRepresentational State Transfer (REST)"An architectural style for building distributed systems based on hypermedia"Open standards-basedTechnology-agnosticClient issues a request to a URIthat represents a resource; Request verbthat indicates the operationto perform on the resource. Request bodyincludes the datarequired for the APIs are stateless; each request may be handled by a different server-side API Best Practices -@ardalisURI Design ConsiderationsURI values should correspond to nouns /customers, /authors, /ordersURI values should typically be plural (when referring to collections) Again, /customers, /authors, /ordersRequests for individual resources should append an identifier: Example: /customers/1, /orders/00234 Web API Best Practices -@ardalisPrinciple of Least Asto
Not generally an issue with Web APIs REST services should (typically) return the resource in the body of POST commands, not redirect Web API Best Practices - @ardalis. What to Return? ... // Enable middleware to serve generated Swagger as a JSON endpoint. // Enable middleware to serve swagger-ui specifying the Swagger JSON endpoint. app ...
Domain:
Source:
Link to this page:
Please notify us if you found a problem with this document:
{{id}} {{{paragraph}}}