Adds a setting-option to add swagger plugins. #4922
+64
−13
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
resolves #4921 |
|
Fixes #4921 |
Saibamen
suggested changes
Nov 27, 2024
There was a problem hiding this comment.
Please merge latest master branch and fix conflicts after https://github.com/RicoSuter/NSwag/pull/5031/files
| @@ -59,7 +62,8 @@ | |||
| ], | |||
| plugins: [ | |||
| SwaggerUIBundle.plugins.DownloadUrl, | |||
| disableTryItOutPlugin | |||
| disableTryItOutPlugin | |||
There was a problem hiding this comment.
Suggested change
| disableTryItOutPlugin | |
| disableTryItOutPlugin, |
Comment on lines
+20
to
+22
|
|
||
| {PluginScripts} | ||
|
|
There was a problem hiding this comment.
Suggested change
| {PluginScripts} | |
| {PluginScripts} |
| @@ -60,6 +62,7 @@ | |||
| plugins: [ | |||
| SwaggerUIBundle.plugins.DownloadUrl, | |||
| disableTryItOutPlugin | |||
There was a problem hiding this comment.
Suggested change
| disableTryItOutPlugin | |
| disableTryItOutPlugin, |
Comment on lines
+20
to
+21
|
|
||
| {PluginScripts} |
There was a problem hiding this comment.
Suggested change
| {PluginScripts} | |
| {PluginScripts} |
| .Replace("{DocumentTitle}", DocumentTitle) | ||
| .Replace("{AdditionalPlugins}", GeneratePluginsList(AdditionalPlugins.Keys.ToArray())) | ||
| .Replace("{PluginScripts}", GetCustomScripts(AdditionalPlugins.Values.ToArray(), request)); | ||
|
|
| @@ -16,6 +16,8 @@ | |||
| using System.Text; | |||
| using System.Threading.Tasks; | |||
| using System.Threading; | |||
| using System.Runtime.CompilerServices; | |||
|
|
|||
| protected string GetCustomScripts(string[] scriptPaths, HttpRequest request) | ||
| #endif | ||
| { | ||
| if ((scriptPaths == null )|| (scriptPaths.Count()==0)) |
There was a problem hiding this comment.
Suggested change
| if ((scriptPaths == null )|| (scriptPaths.Count()==0)) | |
| if ((scriptPaths == null ) || (scriptPaths.Count() == 0)) |
|
|
||
| return builder.ToString(); | ||
| } | ||
|
|
Comment on lines
+164
to
+165
| /// <param name="pluginsList"></param> | ||
| /// <returns></returns> |
There was a problem hiding this comment.
Suggested change
| /// <param name="pluginsList"></param> | |
| /// <returns></returns> |
| @@ -132,5 +157,21 @@ protected string GenerateAdditionalSettings(IDictionary<string, object> addition | |||
|
|
|||
| return code; | |||
| } | |||
|
|
|||
| /// <summary> | |||
| /// Generates the JavaScript plugins object to inset into the html. | |||
There was a problem hiding this comment.
Suggested change
| /// Generates the JavaScript plugins object to inset into the html. | |
| /// Generates the JavaScript plugins object to inset into the HTML. |
To link PR and issues, this text needs to be in the first comment. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I wanted a way to add swagger plugins through NSwag.
Changed the signature of GetCustomScriptHtml to allow reuse.
Added setting for plugin with name and script path.
Script must be hosted in your application and reachable by swagger.