GitHub Copilot Customization Explained for Beginners: Instructions, Prompt Files, Skills, Agents, and Hooks  Introduction If you've recently started using GitHub Copilot, you've probably come across terms like Instructions , Prompt Files , Skills , Agents , and Hooks . At first glance, they all seem to do the same thing—they tell Copilot what to do. So why does GitHub have five different customization features? The answer is simple: each feature solves a different problem. Think of GitHub Copilot as a new developer joining your team. On their first day, you don't just hand them code. You explain your coding standards, give them reusable templates, teach them specialized knowledge, assign them a role, and automate repetitive tasks. That's exactly how GitHub Copilot customization works. In this article, you'll learn what each feature does, when to use it, and how they all work together. By the end, you'll know which feature to start with and which ones can wait un...
Post a Comment

Swagger UI for Azure Function v2 & v3 APIs

In this blog post, we will see how to setup Swagger UI for Azure Function APIs in v2 and v3. Now you might be wondering why Swagger? Swagger is a language-agnostic specification for describing REST APIs, it also referred to as OpenAPI. Swagger UI offers a web-based UI that provides information about your REST APIs service.

Prerequisites

  1. HTTP trigger Azure function provisioned or created in C#
  2. Azure DI enabled on Azure Function, for more details refer here with relevant package version installed based on Azure Function version.

Integrating Swagger UI into our Applications

1. Install the appropriate package based on the Azure Function version which you are dealing with from the below table. Unfortunately, it's not a single package for both versions due to Azure function v3 because v3 makes use of ASP.NET Core 3.1 which introduces a new serializer System.Text.Json (STJ) out-of-the-box.

 Azure Function Version Nuget package
 v2          AzureFunctions.Extensions.Swashbuckle
 v3 AzureExtensions.Swashbuckle

2. Update startup code as shown below by adding Swashbuckle.

3. Add Open API and Swagger UI function
 
4. Sample HTTP trigger code as shown below

5. Run Azure function locally and you should be able to see swagger ui as shown below

Swagger UI

6. Use "SwaggerIgnoreAttribute", If you have Http Trigger Functions that you do not want to add to Open API.
7. Finally if you want to import XMLCommentDocument you can add it to Open API by navigating to host.json and placing the below code snippet with XML file in your project.

{
  "version": "2.0",
  "extensions": {
    "Swashbuckle": {
      "XmlPath": "SwaggerCommentDocument.xml"
    }
  }
}


Related Articles

Comments

Post a Comment

Popular posts from this blog

Automate Certificate Issue and Renewal process - k8s cluster

Image
In this blog post, we will see if you have an existing or new Kubernetes cluster with Ingress resources how do we auto-renew the certificates. If it's not auto-renewed things need to be manually done e.g. every three months you have to renew certificates, delete the expired certificate and secret, update with new certificate secrets accordingly.  Manual is always tedious and not an ideal solution especially for your Test & Production environment.  Pre-requisites Install and setup kubectl Install and setup Helm Kubernetes cluster already provisioned with Ingress resources. Note: The scope of the blog post is to show how the certificate renewal process can be automated, the same logic can be moved to your Deployment pipelines. Install Cert Manager Installing Cert-Manager CRDs using the below command. #For Kubernetes 1.15+ kubectl apply --validate = false \ -f https://github.com/jetstack/cert-manager/releases/downloa...
Read more

Tidy up - Unused Project and Nuget package reference using Visual Studio 2019

Image
If you are a Developer/Architect using Visual Studio as IDE for your development activities, this blog post will be of your interest. During the Ignite 2021 conference, Microsoft released Visual Studio 2019 v16.9 and v16.10 Preview 1. As part of version 16.10 Preview 1, one of the cool features they introduced is to "Remove Unused References..." for any Projects and Nuget packages that are not in use. At the time of writing this blog post, we have Visual Studio Version 16.10.0 (official release) which includes this new feature.  As part of development, we generally get carried away and introduce new Nuget package references to your project and add new references to your Projects. By the end of development, you will not be 100% sure which are not being referenced and unused which means you will leave those unused project references in your application. Now you might be wondering what's the big deal in it since it doesn't harm. The advantage of removing unused project r...
Read more

Azure App Configuration - How it's different from Azure Key Vault?

Image
Azure App Configuration is a cloud-based managed service that helps developers and infrastructure team members to centralize and manage application configurations and feature flags. Using Azure App Configuration helps to separate application configuration from code. One of the  Twelve-Factor App  principles states  strict separation of config from code  with Azure App configuration this can be easily achieved. Azure App Configuration is now generally available as a free or paid service based on the  pricing  tier you choose as part of provisioning the service.  In the modern world, applications often can run in different geographical locations, can be hosted on services like App Services, virtual machines, Serverless functions, Azure Container Instance, AKS, etc. Managing application configuration for all this type of service can be done in a centralized location using App configuration which means your operations and support team members need not...
Read more