Skip to content

Provide swagger generation options for ASP.NET Core Web API project template #7639

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
mkArtakMSFT opened this issue Feb 15, 2019 · 9 comments
Labels
area-mvc Includes: MVC, Actions and Controllers, Localization, CORS, most templates blocked The work on this issue is blocked due to some dependency
Milestone

Comments

@mkArtakMSFT
Copy link
Member

The WebAPI project should be extended to support swagger generation options with one of the supported providers

@mkArtakMSFT mkArtakMSFT added 1 - Ready area-mvc Includes: MVC, Actions and Controllers, Localization, CORS, most templates labels Feb 15, 2019
@mkArtakMSFT mkArtakMSFT added this to the 3.0.0-preview4 milestone Feb 15, 2019
@dougbu
Copy link
Member

dougbu commented Feb 21, 2019

Removed the feature-code-generation label because this work isn't about service references. (Will likely have other template updates that are for the service reference feature.)

@mkArtakMSFT mkArtakMSFT assigned dougbu and ryanbrandenburg and unassigned dougbu Mar 7, 2019
@mkArtakMSFT mkArtakMSFT changed the title Provide swagger generation options for ASP.NET Core Web API projects Provide swagger generation options for ASP.NET Core Web API project template Mar 8, 2019
@ryanbrandenburg
Copy link
Contributor

Can we get more background on this? Which provider does @danroth27 think we should go with, NSwag or Swashbuckle? Should we include SwaggerUI too? The title and description says "options", but what command-line option could there be other than "use swagger" (and "use SwaggerUI" if we want that)? We'll have to expose this as VS UI, have we talked with them about this?

@danroth27
Copy link
Member

@ryanbrandenburg Please work with @glennc on this.

@ryanbrandenburg
Copy link
Contributor

From Glen:

The goal is an option during project creation add either swashbuckle or nswag. Though I think the engineering team still has an ask on them to do the due diligence required to allow us to actually depend on nswag, so it might only be swashbuckle in the short term. This is only the API template. If selected you get the package added and the code to wire it up. Adding the swagger ui endpoint and such. It’s probable that someone needs to enter this in the OSS tools and state that some amount of vetting has been done. This and the nswag thing should both be on one of your managers to organize. Eilon certainly knew about it but we might need to check with Kevin now as it probably fell off.

@rynowak
Copy link
Member

rynowak commented May 20, 2019

note: that adding an external dependency like this requires a security review, even if we don't expect to find anything.

@ryanbrandenburg
Copy link
Contributor

Per in-person conversation with Glen I'm operating under the assumption that we won't be adding this option to F#.

@ryanbrandenburg ryanbrandenburg added blocked The work on this issue is blocked due to some dependency 1 - Ready and removed Working labels May 29, 2019
@mkArtakMSFT
Copy link
Member Author

Moved this to Preview7 as we are still blocked here.

@mkArtakMSFT
Copy link
Member Author

Moving this to 3.1 because of the risks involved.

@pranavkm
Copy link
Contributor

pranavkm commented Nov 6, 2020

We did this for 5.0. Swashbuckle is enabled by default for API project templates.

@pranavkm pranavkm closed this as completed Nov 6, 2020
@pranavkm pranavkm modified the milestones: Backlog, 5.0.0 Nov 6, 2020
@ghost ghost locked as resolved and limited conversation to collaborators Dec 6, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area-mvc Includes: MVC, Actions and Controllers, Localization, CORS, most templates blocked The work on this issue is blocked due to some dependency
Projects
None yet
Development

No branches or pull requests

6 participants