Generate an Open API Definition for Azure Function App
  • 09 Sep 2022
  • 1 Minute to read
  • Contributors
  • Comment
  • Dark
    Light
  • PDF

Generate an Open API Definition for Azure Function App

  • Comment
  • Dark
    Light
  • PDF

#ServerlessTips - Azure Functions
Author: Steef-Jan Wiggers Azure MVP

Generate an Open API Definition for Azure Function App to expose function methods

Azure Functions are designed to enable the creation of small pieces of reusable methods, easily shared across a serverless architecture. You can build these methods to serve a single purpose and respond to events in other Azure Services, or through HTTP requests from external clients. Moreover, you can group a few of these methods in a Function App and expose them as an API.

The Platform features in a Function App provide a feature called API definition and allows you to generate an OpenAPI specification.

With the specification, you can use it for any other level of integration such as integration with Power Apps, Microsoft Flow, or import it into API Management to expose your methods securely to external developers.

You can select methods in your functions by navigating with each function to the integrate tab. Next, you choose all the methods and header types for which you want to generate the API Specification.

image.png

In the platform feature tab under Function App Settings choose the API definition feature available under API Group. Subsequently, click generate API definition to create the specification.

image.png

With the specification, you can export it to PowerApps or Flow, or import in API Management.

Azure-functions.png


Was this article helpful?