Repository files navigation

There is anactive branch that converts all these samples to ASP.NET Core 3.1 and ASP.NET Core 5.

If you are studying ASP.NET Core, I am lurking on thisGitter Channel.

Hi Nuget visitors, if you have problem finding the sample you are looking for, please use the github search functionality or otherwisefile a case. I will be happy to point you to the right direction.

The goal of this project is to enable .NET programmers to learn the new ASP.NET Core stack from the ground up directly from code. There is so much power in the underlying ASP.NET Core stack. Don't miss them!

I highly recommend usingVisual Studio Code to play around with these samples but it is not required. You can use Visual Studio 2019 as well.

Note: If you encounter problem with downloading packages or Nuget, try the following commandnuget.exe locals -clear all.

ASP.NET Core API Browser is also veryhandy.

To run these samples, simply open your command line console, go to each folder and executedotnet watch run.

Most of the examples here usesMicrosoft.AspNetCore package which is a package consisted of

  Microsoft.AspNetCore.Diagnostics  Microsoft.AspNetCore.HostFiltering  Microsoft.AspNetCore.Hosting  Microsoft.AspNetCore.Routing  Microsoft.AspNetCore.Server.IISIntegration  Microsoft.AspNetCore.Server.Kestrel  Microsoft.AspNetCore.Server.Kestrel.Https  Microsoft.Extensions.Configuration.CommandLine  Microsoft.Extensions.Configuration.EnvironmentVariables  Microsoft.Extensions.Configuration.FileExtensions  Microsoft.Extensions.Configuration.Json  Microsoft.Extensions.Configuration.UserSecrets  Microsoft.Extensions.Logging  Microsoft.Extensions.Logging.Configuration  Microsoft.Extensions.Logging.Console  Microsoft.Extensions.Logging.Debug

When an example requires packages that are not listed here, it will be added to the project file.

All these projects require the following dependencies

   "Microsoft.AspNetCore" : "2.1.0"

• Hello World (22)

  • Hello World with reload

    Setup your most basic web app and enable the change+refresh development experience.

    We are usingIApplicationBuilder Run, an extension method for adding terminal middleware.

  • Startup class

    • Hello World with startup basic

      This project contains all the available services available in Startup class constructor,ConfigureServices andConfigure methods.

    • Hello World with custom startup class name

      You don't have to call your startup classStartup. Any valid C# class will do.

    • Hello World with responding to multiple urls

      Configure so that your web app responds to multiple urls.

    • Hello World with multiple startups

      This project highlights the fact that you can create multiple Startup classes and choose them at start depending on your needs.

    • Hello World with multiple startups using environment

      This project highlights the fact that you can create multiple startup classes and choose them at start depending on your needs depending on your environment (You do have to name the startup class with Startup).

    • Hello World with multiple Configure methods based on environment

      This project demonstrates the ability to pickConfigure method in a single Startup class based on environment.

    • Hello World with multiple ConfigureServices methods based on environment

      This project demonstrates the ability to pickConfigureServices method in a single Startup class based on environment.

    • Hello World with an implementation of IStartup interface

      We are really getting into the weed of startup right now. This is an example on how to implementIStartup directly.

    • Hello World without a startup class

      Why? just because we can.

    • Hello world with IStartupFilter

      UseIStartupFilter to configure your middleware. This is an advanced topic.This article tries at explainingIStartupFilter. I will add more samples soIStartupFilter can be clearer.

  • Show errors during startup

    Show a detailed report on exceptions that happen during the startup phase of your web app. It is very useful during development.

  • Show Connection info

    Enumerate the connection information of a HTTP request.

  • Environmental settings

    Set your application environment toDevelopment orProduction or other mode directly from code.

  • Console logging

    Setup a basic logging in your app and show it to console.

    We add the following dependencies"Microsoft.Extensions.Logging": "1.1.0" and"Microsoft.Extensions.Logging.Console": "1.1.0"

    We are usingIApplicationBuilder Run, an extension method for adding terminal middleware.

  • Console logging - without framework log

    Filter out frameworking logging from your log output. Without filtering, logging can get very annoying because the framework produces a lot of messages.

  • Hello World with middlewares

    ASPNetCore is built on top of pipelines of functions called middleware.

    We are usingIApplicationBuilder Use, an extension method for adding middleware andIApplicationBuilder Run.

  • IApplicationLifetime

    Respond to application startup and shutdown.

    We are usingIApplicationLifetime that trigger events during application startup and shutdown.

  • IHostingEnvironment

    IHostingEnvironment is available atStartup constuctor andStartup.Configure. This sample shows all the properties available in this interface.

  • IHostingEnvironment at ConfigureServices

    This sample shows how to accessIHostingEnvironment fromConfigureServices.

  • Application Environment

    This sample shows how to obtain application environment information (target framework, etc).

  • Adding HTTP Response Header

    Demonstrate on how to add a response header and where is allowed place to do it.

• Request(9)

  This section shows all the different ways you capture input and examine request to your web application.

  • HTTP Verb (1)

    • Get request verb

      Detect the verb/method of the current request.

  • Headers (3)

    • Access Request Headers

      Enumerate all the available headers in a request.

    • Access Request Headers using common HTTP header names contained in HeaderNames

      This sample shows all the common HTTP header names contained inHeaderNames class. So instead of using string to obtain a HTTP Header, you can just use a convenient constant such asHeaderNames.ContentType.

    • Type Safe Access to Request Headers

      Instead of using string to access HTTP headers, use type safe object properties to access common HTTP headers.

  • Query String (1)

    • Single value query string

      Access single value query string.

    • Multiple values query string

      Access multiples values query string.

    • List all query string values

      List all query string values. Also shows the implicat conversion fromStringValues tostring.

  • Form (2)

    • Form Values

      Handles the values submitted via a form.

    • Form Upload File

      Upload a single file and save it to the current directory (check out the usage of.UseContentRoot(Directory.GetCurrentDirectory()))

  • Cookies (2)

    • Cookies

      Read and write cookies.

    • Removing cookies

      Simply demonstrates on how to remove cookies.

• Routing (9)

  We go deep intoMicrosoft.AspNetCore.Routing library that provides routing facilities in your aspnetcore apps.There are several samples to illuminate this powerful library.

  • Router

    A single route handler that handles every path request.

  • Router 2

    Two route handler, one for home page (/) and the other takes the rest of the request using asterisk (*) in the url template.

  • Router 3

    We are exploring default handler - this is the entry point to create your own framework.

  • Router 4

    We are mixing optional route parameter, route parameter with default value and default handler.

  • [Router 5]

    This is still broken. I am trying to figure out how to do nested routing. Wish me luck!

  • Router 6

    We are building a template route segment by segment and parts by parts, oldskool. We are usingTemplateMatcher,TemplateSegment andTemplatePart.

    Hold your mask, we are going deep.

  • Router 7

    We are creating a routing template with two segments, one with Literal part and the other Parameter part, e.g, "/page/{*title}"

  • Router 8

    We are creating a routing template with one segment consisted of two parts, one Literal and one Parameter, e.g. "/page{*title}". Note the difference between this example and Router 7.

  • Router 9

    I am still trying to determine whetherTemplateMatcher uses theInlineConstraint information.

    Update: No,TemplateMatcher does not run constraints.#362

  • Router 10

    We have been building aRouteTemplate manually usingTemplateSegment andTemplatePart. In this example we are usingTemplateParser to build theRouteTemplate using string.

• Middleware (12)

  We will explore all aspect of middleware building in this section.

  • Middleware 1

    This example shows how to pass information from one middleware to another usingHttpContext.Items.

  • Middleware 2

    As a general rule, only one of your Middleware should write to Response in an execution path. This sample shows how to work around this by buffering the Response.

    e.g.

    If path/ involves the execution of Middleware 1, Middleware 2 and Middleware 3, only one of these should write to Response.

  • Middleware 3

    This is the simplest middleware class you can create.

  • Middleware 4

    Useapp.Map (MapMiddleware) to configure your middleware pipeline to respond only on specific url path.

  • Middleware 5

    Nestedapp.Map (showRequest.Path andRequest.PathBase).

  • Middleware 6

    Useapp.MapWhen(MapWhenMiddleware) and Nestedapp.Map (showRequest.Path andRequest.PathBase).

  • Middleware 7

    UseMapMiddleware andMapWhenMiddleware directly without using extensions (showRequest.Path andRequest.PathBase).

  • Middleware 8

    Demonstrate the various ways you can inject dependency to your middleware classmanually.

  • Middleware 9

    Demonstrate how to ASP.NET Core built in DI (Dependency Injection) mechanism to provide dependency for your middleware.

  • Middleware 10

    Demonstrate that a middleware is a singleton.

  • Middleware 11

    This sample is similar toMiddleware 10 except that this one implementIMiddleware to create Factory-based middleware activation. This means that you can create a middleware that is not a singleton (either Transient or Scoped).

  • Middleware 12

    Contrast the usage ofMapWhen (which branch execution) andUseWhen (which doesn't branch execution) in configuring your Middleware.

• Features (9)

  Features are collection of objects you can obtain from the framework at runtime that serve different purposes.

  • Server Addresses Feature

    Use this Feature to obtain a list of urls that your app is responding to.

  • Server Addresses Feature - 2

    UseIServer interface to access server addressess when you don't have access toIApplicationBuilder.

  • Request Feature

    Obtain details of a current request. It has some similarity to HttpContext.Request. They are not equal.HttpContext.Request has more properties.

  • Connection Feature

    UseIHttpConnectionFeature interface to obtain local ip/port and remote ip/port.

  • Custom Feature

    Create your own custom Feature and pass it along from a middleware.

  • Custom Feature - Override

    Shows how you can replace an implementation of a Feature with another within the request pipeline.

  • Request Culture Feature

    Use this feature to detect the culture of a web request throughIRequestCultureFeature. It needs the following dependency"Microsoft.AspNetCore.Localization": "2.1.0".

  • Session Feature

    Use session within your middlewares. This sample shows a basic usage of in memory session. It needs the following dependency '"Microsoft.AspNetCore.Session" : "1.1.0-"and"Microsoft.Extensions.Caching.Memory" : "2.1.0-"`.

  • Maximum Request Body Size Feature

    Use this feature to read and set maximum HTTP Request body size.

• Dependency Injection (2)

  ASP.NET Corenetcore lives and die by DI. It relies onMicrosoft.Extensions.DependencyInjection library.

  • Dependency Injection 1 - The basic

    Demonstrate the three lifetime registrations for the out of the box DI functionality: singleton (one and only forever), scoped (one in every request) and transient (new everytime).

  • Dependency Injection 3 - Easy registration

    Register all objects configured by classes that implements a specific interface (IBootstrap in this example). This is useful when you have large amount of classes in your project that needs registration. You can register them near where they are (usually in the same folder) instead of registering them somewhere in a giant registration function.

    Note: example 2 is forthcoming. The inspiration has not arrived yet.

• File Provider (2)

  We will deal with various types of file providers supported by ASP.NET Core

  • Physical File Provider - Content and Web roots

    Access the file information on your Web and Content roots.

  • Custom File Provider

    Implement a simple and largely nonsense file provider. It is a good starting point to implement your own proper File Provider.

• In Memory Caching (a.k.a local cache) (4)

  These samples depends onMicrosoft.Extensions.Caching.Memory library.

  • Caching - Absolute/Sliding expiration

    This is the most basic caching you can use either by setting absolute or sliding expiration for your cache. Absolute expiration will remove your cache at a certain point in the future. Sliding expiration will remove your cache after period of inactivity.

  • Caching 2 - File dependency

    Add file dependency to your caching so when the file changes, your cache expires. Make sure to setcache-file.txt to copy over to bin.

  • Caching 3 - Cache removal event

    Register callback when a cached value is removed.

  • Caching 4 - CancellationChangeToken dependency

    Bind several cache entries to a single dependency that you can reset manually.

• Configuration (7)

  This section is all about configuration, from memory configuration to INI, JSON and XML.

  • Configuration

    This is the 'hello world' of configuration. Just use a memory based configuration and read/write values to/from it.

  • Configuration - Options

    Use IOptions at the most basic.

  • Configuration - Environment variables

    Load environment variables and display all of them.

  • Configuration - INI file

    Read from INI file. It requires taking a new dependency,"Microsoft.Extensions.Configuration.INI" : "2.1.0".

  • Configuration - INI file - Options

    Read from INI file (with nested keys) and IOptions. It requires taking two new dependencies,"Microsoft.Extensions.Configuration.INI" : "2.1.0" and"Microsoft.Extensions.Options.ConfigurationExtensions" : "2.1.0".

  • Configuration - XML file

    Read from XML file. It requires taking a new dependency,"Microsoft.Extensions.Configuration.Xml" : "2.1.0".

    Note: This Xml Configuration provider does not support repeated element.

    The following configuration settings will break:

    <appSettings>  <add key="webpages:Version" value="3.0.0.0" />  <add key="webpages:Enabled" value="false" /></appSettings>

    On the other hand you can get unlimited nested elements and also attributes.

  • Configuration - XML file - Options

    Read from XML file and use IOptions. It requires taking two new dependencies,"Microsoft.Extensions.Configuration.Xml" : "2.1.0" and"Microsoft.Extensions.Options.ConfigurationExtensions" : "2.1.0".

• Localization and Globalization (6)

  This section is all about languages, culture, etc.

  • Localization

    Shows the most basic use of localization using a resource file. This sample only supports French language (because we are fancy). It needs the following dependency"Microsoft.AspNetCore.Localization": "2.1.0" and"Microsoft.Extensions.Localization": "2.1.0".

  • Localization - 2

    We build upon the previous sample and demonstrate how to switch request culture via query string using the built inQueryStringRequestCultureProvider. This sample supports English and French.

  • Localization - 3

    Demonstrate the difference betweenCulture andUI Culture.

  • Localization - 4

    Demonstrate how to switch request culture via cookie using the built inCookieRequestCultureProvider. This sample supports English and French.

  • Localization - 5

    Demonstrate using Portable Object (PO) files to support localization instead of the cumbersome resx file. This sample requiresOrchardCore.Localization.Core package. This sample requiresASPNET Core 2.

  • Localization - 6

    This is a continuation of previous sample but with context, which allows the same translation key to return different strings.

• URL Redirect/Rewriting (6)

  This section explore the dark arts of URL Rewriting

  • Rewrite

    Shows the most basic of URL rewriting which willredirect (returnsHTTP 302) anything to the home page "/". It requires an additional"Microsoft.AspNetCore.Rewrite" : "2.1.0-*" dependency.

    If you have used routing yet, I recommend of checking out the routing examples.

  • Rewrite - 2

    Redirect (returnsHTTP 302) anything with an extension e.g. about-us.html or welcome.aspx to home page (/). It also shows how to capture the matched regex values.

  • Rewrite - 3

    Rewrite anything with an extension e.g. about-us.html or welcome.aspx to home page (/). It also shows how to capture the matched regex values.

  • Rewrite - 4

    Permanent Redirect (returnsHTTP 301) anything with an extension e.g. about-us.html or welcome.aspx to home page (/). It also shows how to capture the matched regex values.

  • Rewrite - 5

    Implement a custom redirect logic based onIRule implementation. Require additional dependency of"Microsoft.AspNetCore.StaticFiles": "1.1.0" to serve images.

    This custom redirection logic allows us to simply specify the image file names without worrying about their exact path e.g.'xx.jpg' and 'yy.png'.

  • Rewrite - 6

    Implement a custom redirect logic using lambda (similar functionality to Rewrite - 5). Require additional dependency of"Microsoft.AspNetCore.StaticFiles": "1.1.0" to serve images.

    This custom redirection logic allows us to simply specify the image file names without worrying about their exact path e.g.'xx.jpg' and 'yy.png'.

• Compression (1)

  Enable the ability to compress ASP.NET Core responses. These samples takes a dependency ofMicrosoft.AspNetCore.ResponseCompression": "2.1.0.

  • Default Gzip Output Compression

    Compress everything using the default Gzip compression.

    Everything means the following MIME output

    • text/plain
    • text/css
    • application/javascript
    • text/html
    • application/xml
    • text/xml
    • application/json
    • text/json

• Diagnostics(6)

  These samples take a dependency of"Microsoft.AspNetCore.Diagnostics":"1.1.1".

  • Welcome Page

    Simply show a welcome page to indicate that the app is working properly. This sample does not use a startup class simply because it's just a one line code.

  • Developer Exception Page

    Show any unhandled exception in a nicely formatted page with error details. Only use this in development environment!

  • Custom Global Exception Page

    UseIExceptionHandlerFeature feature provided byMicrosoft.AspNetCore.Diagnostics.Abstractions to create custom global exception page.

  • Custom Global Exception Page - 2

    Similar to the previous one except that that we use the custom error page defined in separate path.

  • Status Pages

    UseUseStatusCodePagesWithRedirects.Beware: This extension method handles your 5xx return status code by redirecting it to a specific url. It will not handle your application exception in general (for this useUseExceptionHandler - check previous samples).

  • Middleware Analysis

    Here we go into the weeds of analysing middlewares in your request pipeline. This is a bit complicated. It requires the following packages:

    • Microsoft.AspNetCore.MiddlewareAnalysis
    • Microsoft.Extensions.DiagnosticAdapter
    • Microsoft.Extensions.Logging.Console

• Static Files(6)

  This additional dependency is required to enable the functionality"Microsoft.AspNetCore.StaticFiles": "1.1.0".

  • Serve static files

    Simply serve static files (html, css, images, etc).

    There are two static files being served in this project, index.html and hello.css. They are stored underwwwroot folder, which is the default folder location for this library.

    To access them you have to refer them directly e.g.localhost:5000/index.html andlocalhost:5000/hello.css.

  • Allow Directory Browsing

    Allow listing and browsing of yourwwwroot folder.

  • Use File Server

    Combines the functionality ofUseStaticFiles, UseDefaultFiles, and UseDirectoryBrowser.

  • Custom Directory Formatter

    Customize the way Directory Browsing is displayed. In this sample the custom view only handles flat directory. We will deal withmore complex scenario in the next sample.

  • Custom Directory Formatter - 2

    Show custom Directory Browsing and handle directory listing as well as files.

  • Allow Directory Browsing

    Use Directory Browsing on a certain path usingDirectoryBrowserOptions.RequestPath, e.g./browse.

• Web Sockets (5)

  We are going to explore websocket functionality provided by ASP.NET Core. All the samples here requireMicrosoft.AspNetCore.WebSockets.

  Warning: These samples are low level websocket code. For production, useSignalR. Yes I will work on SignalR samples soon.

  • Echo Server

    This is the simplest web socket code you can write. It simply returns what you sent. It does not handle the closing of the connection. It does not handle data that is larger than buffer. It only handles text payload.

  • Echo Server 2

    We improve upon the previous sample by adding console logging (requiringMicrosoft.Extensions.Logging.Console package) and handling data larger than the buffer. I set the buffer to be very small (4 bytes) so you can see how it works.

  • Echo Server 3

    We improve upon the previous sample by enabling broadcast. What you see here is a very crude chat functionality.

  • Echo Server 4

    We improve upon the previous sample by handling closing event intiated by the web client.

  • Chat Server

    Implement a rudimentary single channel chat server.

• Server-Sent Events (1)

  • Forever Server

    This server will send a 'hello world' greeting forever.

• Syndications (2)

  We are using the brand newMicrosoft.SyndicationFeed.ReaderWriter package to read RSS and ATOM feeds.

  • Syndication - Read RSS

    This is the shortest amount of code to read an RSS feed. This example read the feed from the inventor of RSS, Dave Winer athttp://scripting.com/rss.xml.

  • Syndication - Read RSS with extensions

    This sample process RSS Outline Extension.

• Utils(3)

  • Status Codes

    Here we contrast between the usage ofMicrosoft.AspNetCore.Http.StatusCodes andSystem.Net.HttpStatusCode.

  • MediaTypeNames

    This class provides convenient constants for some common MIME types. It's not extensive by any means howeverMediaTypeNames.Text.Html andMediaTypeNames.Application.Json come handy.

  • MediaTypeNames - 2

    UsingFileExtensionContentTypeProvider to obtain the correct MIME type of a filename extension.

• Misc (3)

  • Markdown server

    Serve markdown file as html file. You will see how you can create useful app using a few basic facilities in aspnetcore.

    We take"Markdig" : "0.15.1" as dependency.

  • Markdown server - implemented as middleware component

    Serve markdown file as html file. It has the same exact functionality asMarkdown server but implemented using middleware component.

    We take"Markdig" : "0.15.1" as dependency.

    Check out the documentation on how to write your own middleware.

  • Password Hasher server

    Give it a string and it will generate a secure hash for you, e.g.localhost:5000?password=mypassword.

    We add dependency"Microsoft.AspNetCore.Identity": "2.1.0" to enable this functionality.

• Web Utilities(3)

  This section shows various functions avaiable atMicrosoft.AspNetCore.WebUtilities.

  • Query Helpers

    This utility helps you generate query string for your url safely (htRehan Saeed).

  • Parse Query String

    QueryHelpers.ParseQuery allows you to parse a raw query string and access its individual key and values.

  • Reason Phrases

    This utility returns HTTP response phrases given a status code number.

• Uri Helper(5)

  This section shows various methods available atMicrosoft.AspNetCore.Http.Extensions.UriHelper.

  • Get Display Url

    Request.GetDisplayUrl() shows complete url with host, path and query string of the current request. It's to be used for display purposes only.

  • Get Encoded Url

    Request.GetEncodedUrl() returns the combined components of the request URL in a fully escaped form suitable for use in HTTP headers and other HTTP operations.

  • Get Encoded Path and Query

    UriHelper.GetEncodedPathAndQuery returns the relative URL of a request.

  • From Absolute

    UriHelper.FromAbsolute separates the given absolute URI string into components.

  • Build Absolute

    UriHelper.BuildAbsolute combines the given URI components into a string that is properly encoded for use in HTTP headers. This sampleshows 9 ways on how to use it.

• Trimming (1)

  This section shows the various way on how to trim the size of your application by usingMicrosoft.Packagin.Tools.Trimming

  • Trimming Microsoft.AspNetCore.All hello world application

    Rundotnet publish ordotnet build and read the output in your terminal. It will read something similar toTrimmed 115 out of 168 files for a savings of 18.93 MB Final app size is 3.07 MB. You can turn off the trimming by setting<TrimUnusedDependencies>true</TrimUnusedDependencies> tofalse at the project file.

• Email (1)

  This section shows samples of usingMailKit, which is essentiallythe library to use for sending and receiving email in ASP.NET Core.

  • Send email

    This shows an example on how to send an email using SMTP.

    Thanks to@Kinani95.

  • Keeping track of anonymous users

    Keep track of anonymous user in your ASP.NET Core (useful in scenario such as keeping track of shopping cart) usingReturnTrue.AspNetCore.Identity.Anonymous library.

• Middleware (1)

  • Response Buffering

    UseMicrosoft.AspNetCore.Buffering 0.2.2 middleware to implement response buffering facility. This will allow you to change your response after you write them.

• Device Detection (1)

  The samples in this section rely onWangkanai.Detection library.

  • Device Detection

    This is the most basic device detection. You will be able to detect whether the client is a desktop or a mobile client.

• Owin (1)

  All these samples requireMicrosoft.AspNetCore.Owin package. These are low level samples and in most cases are not relevant to your day to day ASP.NET Core development.

  • Owin

    Hello world the hard way.

• Image Sharp (1)

  All these samples requireSixLabors.ImageSharp.Web middleware package. This middleware is an excelent tool to process your day to day image processing need.

  • Image-Sharp

    This example shows how to enable image resizing functionality to your site. It's super easy and the middleware takes care of caching, etc.

Generic Host is an awesome way to host all sort of long running tasks and applications, e.g. messaging, background tasks, etc.

This section is dedicated to all the nitty gritty of Generic Host. All the examples in this section rely onMicrosoft.AspNetCore.App package.

• Hello World

  This is the hello world equivalent of a Generic Host service.

• Hello World using Console Lifetime

  UseUseConsoleLifetime implicitly.

• Startup and Shutdown order

  Demonstrates the startup and shutdown order of hosted services.

• Start and stop the host

  Demonstrates starting and stopping the host programmatically.

• A service with timed execution

  Demonstrate processing a task on a regular interval usingTask.Delay.

• Configure Host using Dictionary

  Demonstrate the way to inject configuration values to the host using Dictionary.

• Configure Environment

  Set your environment usingEnvironmentName.Development orEnvironmentName.Production orEnvironmentName.Staging.

• Configure Logging

  Configure logging for your Generic Host.

• Listen to IApplicationLifetime events

  InjectIApplicationLifetime and listen toApplicationStarted,ApplicationStopping andApplicationStopped events. This is important to allow services to be shutdown gracefully. The shutdown process blocks untilApplicatinStopping andApplicationStopped events complete.

• Contributor Guidelines
• Code of Conduct