Azure / Azure/azure-functions-openapi-extension

Automatically generate OpenAPI specification based on functions

Open
#273 6 comments 3 reactions 0 assignees View on GitHub
discussion
Dominant language
C#
Stars
388
Forks
202
PR merge metrics
No merged PRs in 30d

Description

**Describe the issue**
At the moment you have to manually add attribute classes on top of the FunctionName decorator to enable OpenAPI metadata and make the method visible in the swagger-ui.

**Expected behavior**
OpenAPI specification should be generated automatically based on Functions with HTTP-Trigger.

**Additional context**
E.g. Swashbuckle for ASP.NET Core has the [Swagger-Generator](https://www.nuget.org/packages/Swashbuckle.AspNetCore.SwaggerGen/) which does exaclty that.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing how the extension currently uses attribute classes on FunctionName-decorated methods to produce OpenAPI metadata and expose operations in swagger-ui. Compare the requested automatic generation for HTTP-triggered functions with the linked Swashbuckle Swagger Generator. Done means HTTP-triggered functions appear in the generated OpenAPI specification without manually added metadata attributes.

Written by the indexing model from the issue text.

Assessment

Tech stack
azure, csharp, openapi
Domain
api
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.