Building HTTP APIs with ASP.NET Core
- 1. #td17ch Building HTTP APIs with ASP.NET Core Filip Wojcieszyn Tech Lead CloudServices, Sonova
- 3. Before ASP.NET Core HTTP Handlers ASMX WCF Web Http | WCF REST Starter Kit ASP.NET MVC WCF Web API | ASP.NET Web API
- 5. Agenda Plan for today Lightweight HTTP APIs Security Documentation Versioning Demos https://github.com/filipw/aspnetcore-api-samples
- 7. What would Martin Fowler do?
- 11. Lightweight APIs with ASP.NET Core Prefer the IRouter extensions Super lightweight - modeled after other platforms - e.g. Node, Go, Swift Use MVC for more complex backends Don’t unnecessarily rely on the full framework When using MVC, pick and choose pieces you need AddMvcCore() method allows you to add only most basic framework services
- 12. Super lightweight Whole API in single C# file No MVC Minimal footprint
- 13. How To Not Set Up an MVC-based API
- 14. How To Set Up an MVC API
- 15. Security
- 16. HTTP API Security Use JSON Web Tokens (JWT) IdentityServer4 is the most popular OpenID Connect and OAuth 2.0 framework for ASP.NET/ASP.NET Core Tokens can be issued from an embedded server too API could act both as identity and resource server at the same time ASP.NET Core introduces “Authorization Policies” Centralized way to define required claim validations
- 18. Securing an API (embedded server)
- 19. Documentation
- 20. HTTP API Documentation Swagger has become a de facto standard Defines swagger.json descriptor file, that allows easy client generation Swashbuckle package for ASP.NET Core Can generate swagger.json for your MVC-based HTTP API ASP.NET Core MVC exposes IApiExplorer service In case you need to manually traverse the endpoints
- 24. Versioning
- 26. HTTP API Versioning Approaches URI-based GET /v1/contacts GET /contacts?v=1 Header-based GET /contacts Version: 2 Media type-based GET /contacts Accept: application/vnd.contact-v2+json
- 27. HTTP API Versioning packages Microsoft.AspNetCore.Mvc.Versioning A Microsoft versioning package for ASP.NET Core MVC WebApiContrib.Core.Versioning A community versioning package for ASP.NET Core MVC
- 28. © 2017 Microsoft Corporation. All rights reserved. Microsoft, Windows, Windows Vista and other product names are or may be registered trademarks and/or trademarks in the U.S. and/or other countries. The information herein is for informational purposes only and represents the current view of Microsoft Corporation as of the date of this presentation. Because Microsoft must respond to changing market conditions, it should not be interpreted to be a commitment on the part of Microsoft, and Microsoft cannot guarantee the accuracy of any information provided after the date of this presentation. MICROSOFT MAKES NO WARRANTIES, EXPRESS, IMPLIED OR STATUTORY, AS TO THE INFORMATION IN THIS PRESENTATION.
- 29. © 2017 Microsoft Corporation. All rights reserved. Microsoft, Windows, Windows Vista and other product names are or may be registered trademarks and/or trademarks in the U.S. and/or other countries. The information herein is for informational purposes only and represents the current view of Microsoft Corporation as of the date of this presentation. Because Microsoft must respond to changing market conditions, it should not be interpreted to be a commitment on the part of Microsoft, and Microsoft cannot guarantee the accuracy of any information provided after the date of this presentation. MICROSOFT MAKES NO WARRANTIES, EXPRESS, IMPLIED OR STATUTORY, AS TO THE INFORMATION IN THIS PRESENTATION.