API Documentation
Start course
1h 22m

You’ve got an idea for a great web app, or maybe you’ve already started building it. The next question is how are you going to get it out there on the Internet?

In this course, you will learn how you can quickly and easily set up a website and publish your app to the world with Azure App Service. Of course, web apps are a lot more complex and varied than just HTML pages and we will see how App Service supports a range of programming languages, frameworks, and even operating systems. We will explore features that greatly simplify application deployment and management, as well as those that will increase your app’s functionality like authentication and accessing on-premise data. App Service as with other Azure products has a raft of tools for monitoring and logging so you can make sure your app is performing optimally.

For any feedback, queries, or suggestions relating to this course, please contact us at

Learning Objectives

  • Deploy apps using the Azure App Service
  • Create a web app using the Azure Portal
  • Create a web app using Visual Studio
  • Understand the configuration and diagnostic capabilities available from Azure App Service
  • Understand the advanced features of the service such as container deployment and deployment slots

Intended Audience

This is a beginner level course suited developers or anyone wanting to know how to deploy web apps to the Azure cloud.


To get the most from this course, you should have a basic understanding of the software development lifecycle, while knowing how to code would be a plus.

Course source code

.NET 5.0 demo code


Docker Hub


.NET Core 3.1 demo code





When it comes to documenting your API it’s not as simple or onerous as typing lots of details into a text file. API documentation refers to publishing a JSON description of your API’s methods in a standard format. There are a few tools that will assist you in that task. 

Let’s look at how Swagger and it’s AspNetCore variant Swashbuckle can be used to implement API documentation. The first thing we must do is add the Swashbuckle packages to our project, plus the Microsoft.OpenApi package. Next, open startup.cs, go to ConfigureServices and add SwaggerGen to services with the Swagger document option. Inside the configure method tell the app to user Swagger and SwaggerUI. The Swagger endpoint is saying that when “/swagger” is appended to your app’s URL a JSON file at “/swagger/v1/swagger.json” will be produced with the title LorryLog API V1. When we run the app and go to swagger we get this nice UI listing all the methods and parameters of our API. At the top, there is a link to the JSON file in OpenApi format describing the API.

Ok, so what are we going to do with our swagger.json document? Well, we can use it as our API definition location as not all APIs will be using Swagger. I’ll append the swagger.json document path to the API URL and save. API definition is the location where other developers can get your API’s metadata, making it easier for them to consume your API.

About the Author
Learning Paths

Hallam is a software architect with over 20 years experience across a wide range of industries. He began his software career as a  Delphi/Interbase disciple but changed his allegiance to Microsoft with its deep and broad ecosystem. While Hallam has designed and crafted custom software utilizing web, mobile and desktop technologies, good quality reliable data is the key to a successful solution. The challenge of quickly turning data into useful information for digestion by humans and machines has led Hallam to specialize in database design and process automation. Showing customers how leverage new technology to change and improve their business processes is one of the key drivers keeping Hallam coming back to the keyboard.