Skip to content

Add OpenAPI/Swagger support to minimal actions #30662

New issue
New issue
Closed
Closed
Add OpenAPI/Swagger support to minimal actions#30662
Assignees
halter73
Labels
Needs: DesignThis issue requires design work before implementating.area-minimalIncludes minimal APIs, endpoint filters, parameter binding, request delegate generator etcenhancementThis issue represents an ask for new feature or an enhancement to an existing onefeature-minimal-actionsController-like actions for endpoint routing
Milestone
 
6.0-preview6
@halter73

Description

@halter73
halter73
opened on Mar 4, 2021
  • Ideally done using purely endpoint metadata
  • Might be done by leveraging Mvc.ApiExploer and implementing IApiDescriptionProvider
  • Otherwise, needs design

Activity

halter73
added
Needs: DesignThis issue requires design work before implementating.
area-mvcIncludes: MVC, Actions and Controllers, Localization, CORS, most templates
feature-minimal-actionsController-like actions for endpoint routing
on Mar 4, 2021
JamesNK

JamesNK commented on Mar 4, 2021

@JamesNK
JamesNK
on Mar 4, 2021
Member

I added Swashbuckle support using endpoint metadata for gRPC HTTP API

See: https://github.com/aspnet/AspLabs/tree/002b32674e5a4ff306158618f9d0789707e70753/src/GrpcHttpApi/src/Microsoft.AspNetCore.Grpc.Swagger

mkArtakMSFT
added this to the Next sprint planning milestone on Mar 8, 2021
ghost

ghost commented on Mar 8, 2021

@ghost
ghost
on Mar 8, 2021

Thanks for contacting us.
We're moving this issue to the Next sprint planning milestone for future evaluation / consideration. We will evaluate the request when we are planning the work for the next milestone. To learn more about what to expect next and how this issue will be handled you can read more about our triage process here.

halter73
added
area-servers
and removed
area-mvcIncludes: MVC, Actions and Controllers, Localization, CORS, most templates
on Mar 30, 2021
BrennanConroy
modified the milestones: Next sprint planning, 6.0-preview4, 6.0-preview5 on Apr 20, 2021
BrennanConroy
assigned
BrennanConroy
and
jkotalik
and unassigned
BrennanConroy
on Apr 20, 2021

6 remaining items

halter73
assigned
halter73
and unassigned
JamesNK
on May 17, 2021
BrennanConroy
modified the milestones: 6.0-preview5, 6.0-preview6 on May 17, 2021
halter73
mentioned this on Jun 10, 2021
bradygaster

bradygaster commented on Jun 10, 2021

@bradygaster
bradygaster
on Jun 10, 2021 · edited by bradygaster
Member

Notes from our chat:

  • need to provide non-XML-docs method of allowing metadata customization. We'd need to satisfy the absolute minimum OpenAPI v2 metadata to pass a validator
  • okay to optimize for attributes for commentary/metadata over XML doc comments
  • planning on supporting OpenAPI v2 at first, V3 will come later
  • need to support customization of description and operationId
  • operationId should match the method name by default
halter73
closed this as completedon Jun 24, 2021
YohanSciubukgian

YohanSciubukgian commented on Jun 24, 2021

@YohanSciubukgian
YohanSciubukgian
on Jun 24, 2021

@bradygaster is there any issue to track progress on OpenApi v3 support ?

bradygaster

bradygaster commented on Jun 24, 2021

@bradygaster
bradygaster
on Jun 24, 2021
Member

This repository would be the best spot. @halter73 do you think a separate issue for supporting v3 would be good so folks who care could follow it on their own and keep up?

halter73

halter73 commented on Jun 24, 2021

@halter73
halter73
on Jun 24, 2021
MemberAuthor

This issue didn't track any work that was specific to any version of OpenAPI/swagger. It's Swashbuckle that takes the ApiExplorer metadata and turns it into OpenAPI/swagger output. It looks like they already support v3 looking at their github. Same for NSwag apparently.

I haven't tested either with v3 though, because I don't even know what I'd be looking for. Are there any new features we'd be able to take advantage of?

bradygaster

bradygaster commented on Jun 24, 2021

@bradygaster
bradygaster
on Jun 24, 2021
Member

Good point @halter73 - if you're using either one of the major OpenAPI outputters, Swashbuckle or NSwag, they both support the output of all the various formats so you should be covered.

danroth27
added
enhancementThis issue represents an ask for new feature or an enhancement to an existing one
on Jul 6, 2021
ghost locked as resolved and limited conversation to collaborators on Aug 6, 2021
amcasey
added
area-minimalIncludes minimal APIs, endpoint filters, parameter binding, request delegate generator etc
and removed
area-runtime
on Jun 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

Needs: DesignThis issue requires design work before implementating.area-minimalIncludes minimal APIs, endpoint filters, parameter binding, request delegate generator etcenhancementThis issue represents an ask for new feature or an enhancement to an existing onefeature-minimal-actionsController-like actions for endpoint routing

Type

No type

Projects

No projects

Milestone

Relationships

None yet

    Development

    No branches or pull requests

      Participants

      @halter73@JamesNK@danroth27@BrennanConroy@jkotalik

      Issue actions
        Add OpenAPI/Swagger support to minimal actions · Issue #30662 · dotnet/aspnetcore