https://github.com/build5nines/azd-csharp-api-swagger
An Azure Developer CLI (`azd`) template to deploy a C# API with Swagger UI to Azure App Service
https://github.com/build5nines/azd-csharp-api-swagger
azure-app-service azure-developer-cli csharp dotnet swagger-ui
Last synced: 12 months ago
JSON representation
An Azure Developer CLI (`azd`) template to deploy a C# API with Swagger UI to Azure App Service
- Host: GitHub
- URL: https://github.com/build5nines/azd-csharp-api-swagger
- Owner: Build5Nines
- License: mit
- Created: 2025-04-10T19:42:01.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2025-04-10T20:56:39.000Z (12 months ago)
- Last Synced: 2025-04-10T21:29:10.712Z (12 months ago)
- Topics: azure-app-service, azure-developer-cli, csharp, dotnet, swagger-ui
- Language: Bicep
- Homepage:
- Size: 71.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# azd-csharp-api-swagger 
An Azure Developer CLI (`azd`) template to deploy a C# API with Swagger UI to Azure App Service
This app contains a really simple TODOs API just as an example to get you started using this as a template for a new project.
## Prerequisites
To deploy this template you will need to have the following installed:
- Azure Developer CLI
- .NET 9+
## Deployment
To use this template, follow these steps using the [Azure Developer CLI](https://learn.microsoft.com/azure/developer/azure-developer-cli/overview):
1. Log in to Azure Developer CLI. This is only required once per-install.
```bash
azd auth login
```
2. Initialize this template using `azd init`:
```bash
azd init --template build5nines/azd-csharp-api-swagger
```
3. Use `azd up` to provision your Azure infrastructure and deploy the web application to Azure.
```bash
azd up
```
4. Once provisioning and deployment has completed, navigate your browser to the **Application URL**, and you will see the Swagger UI for the API App.
## Architecture Diagram

## Azure Resources
These are the Azure resources that are deployed with this template:
- **App Service Plan** - The environment for hosting the App Service web app.
- **App Service** - The App Service web app to deploy and run the .NET API app.
## Author
This `azd` template was written by [Chris Pietschmann](https://pietschsoft.com), founder of [Build5Nines](https://build5nines.com), Microsoft MVP, HashiCorp Ambassador, and Microsoft Certified Trainer (MCT).