Book Image

Hands-On RESTful Web Services with ASP.NET Core 3

By : Samuele Resca
Book Image

Hands-On RESTful Web Services with ASP.NET Core 3

By: Samuele Resca

Overview of this book

In recent times, web services have evolved to play a prominent role in web development. Applications are now designed to be compatible with any device and platform, and web services help us keep their logic and UI separate. Given its simplicity and effectiveness in creating web services, the RESTful approach has gained popularity, and this book will help you build RESTful web services using ASP.NET Core. This REST book begins by introducing you to the basics of the REST philosophy, where you'll study the different stages of designing and implementing enterprise-grade RESTful web services. You'll also gain a thorough understanding of ASP.NET Core's middleware approach and learn how to customize it. The book will later guide you through improving API resilience, securing your service, and applying different design patterns and techniques to achieve a scalable web service. In addition to this, you'll learn advanced techniques for caching, monitoring, and logging, along with implementing unit and integration testing strategies. In later chapters, you will deploy your REST web services on Azure and document APIs using Swagger and external tools such as Postman. By the end of this book, you will have learned how to design RESTful web services confidently using ASP.NET Core with a focus on code testability and maintainability.

Related Content you might be interested in

Current Title:

Small book image
Hands-On RESTful Web Services with ASP.NET Core 3
Samuele Resca
Dec, 2019 | 510 pages
Small book image
Customizing ASP.NET Core 5.0
Jrgen Gutsch
Jan, 2021 | 160 pages
Small book image
ASP.NET Core and Vue.js
Devlin Basilan Duldulao
Jun, 2021 | 478 pages
Small book image
Customizing ASP.NET Core 6.0
Jrgen Gutsch
Dec, 2021 | 204 pages
Table of Contents (26 chapters)
Preface
Preface
Who this book is for
What this book covers
To get the most out of this book
Get in touch
Free Chapter
1
Section 1: Getting Started
Section 1: Getting Started
2
REST 101 and Getting Started with ASP.NET Core
REST 101 and Getting Started with ASP.NET Core
REST
Introducing ASP.NET Core
Preparing your development environment
Summary
3
Section 2: Overview of ASP.NET Core
Section 2: Overview of ASP.NET Core
4
Overview of ASP.NET Core
Overview of ASP.NET Core
Setting up our .NET Core project
Setting up an ASP.NET Core project
Summary
5
Working with the Middleware Pipeline
Working with the Middleware Pipeline
Introducing middleware
Understanding built-in middleware
Summary
6
Dependency Injection System
Dependency Injection System
Dependency inversion principle
Dependency injection in ASP.NET Core
Services life cycle
Summary
7
Web Service Stack in ASP.NET Core
Web Service Stack in ASP.NET Core
What is a controller?
Handling requests using controllers and actions
Data transfer objects
Implementing validation of requests
Summary
8
Routing System
Routing System
Overview of the routing system
Conventional routing
Attribute routing
Routing constraints
Summary
9
Filter Pipeline
Filter Pipeline
Introduction to filters
Concrete filter implementations
Filter use cases
Summary
10
Section 3: Building a Real-World RESTful API
Section 3: Building a Real-World RESTful API
11
Building the Data Access Layer
Building the Data Access Layer
Setting up the project
Implementing the domain model
Data access using ORMs
Implementing a data access layer using EF Core
Testing the EF Core repository
Implementing a data access layer using Dapper
Summary
12
Implementing the Domain Logic
Implementing the Domain Logic
Implementing service classes
Testing the service layer
Implementing request model validation
Dependencies registration
Summary
13
Implementing the RESTful HTTP Layer
Implementing the RESTful HTTP Layer
Implementing the item controller
Testing controllers using the WebApplicationFactory<T> class
Improving the resilience of the API
Exposing related entities
A final overview
Summary
14
Advanced Concepts of Building an API
Advanced Concepts of Building an API
Implementing the soft delete procedure
Implementing HATEOAS
The asynchronous code in ASP.NET Core
Measure response time using middleware
Summary
15
The Containerization of Services
The Containerization of Services
An introduction to containers
Using Docker to run the catalog service
Optimizing Docker images
Summary
16
Service Ecosystem Patterns
Service Ecosystem Patterns
An introduction to the cart service
Implementing resilient communication using an HTTP client
Sharing events using an event bus
Running the cart service using Docker
Summary
17
Implementing Worker Services Using .NET Core
Implementing Worker Services Using .NET Core
Introducing worker services
Implementing a health-checking worker
Running a worker service on Docker
Consuming the sold-out event
Summary
18
Securing Your Service
Securing Your Service
Overview of secure communication
Securing APIs with token-based authentication
Summary
19
Section 4: Advanced Concepts for Building Services
Section 4: Advanced Concepts for Building Services
20
Caching Web Service Responses
Caching Web Service Responses
Introduction to the HTTP caching system
Implementing response caching in ASP.NET Core
Implementing a distributed cache
Summary
21
Logging and Health Checking
Logging and Health Checking
Logging in ASP.NET Core
Implementing the logging part
Implementing logging providers
Implementing a custom log provider in tests
Web service health check
Summary
22
Deploying Services on Azure
Deploying Services on Azure
Getting started with Azure
Pushing containers into Azure Container Registry
Configuring Azure Container Instances
Configuring app services
Summary
23
Documenting Your API Using Swagger
Documenting Your API Using Swagger
Understanding OpenAPI
Implementing OpenAPI in ASP.NET Core services
Summary
24
Testing Services Using Postman
Testing Services Using Postman
Overview of Postman
Importing a collection using OpenAPI
Summary
25
Other Books You May Enjoy
Other Books You May Enjoy
Leave a review - let other readers know what you think

Documenting Your API Using Swagger

In this chapter, we will learn how to document our API using the OpenAPI Specification and how to use Swagger tools to parse and generate the documentation. Documenting APIs is particularly significant when our web service is consumed by an external company or a foreign organization team. Moreover, some services can be considerably complex and expose a lot of endpoints. For this reason, some tools related to the .NET ecosystem guarantee up-to-date API documentation. Two main toolchains can be used in this process: NSwag and Swashbuckle. In this book, we will cover and use NSwag to document our APIs.

In this chapter, we will cover the following topics:

  • Understanding OpenAPI
  • Implementing OpenAPI in ASP.NET Core services

By the end of this chapter, you will be able to automatically generate up-to-date documentation that's compliant with the...

Previous Section
End of Section 1
Next Section