How to add additional custom SyntaxHighlighter's

[ghandic]

Using this reference to implement different languages on the snippets #7181 (comment)

I can get other languages like Python... However, I don't get any syntax highlighting. Is there a way to allow this? I'm putting together a PR to include options for FastAPI

This is where all of the languages are added https://github.com/swagger-api/swagger-ui/blob/cc408812fc927e265da158bf68239530740ab4cc/src/core/syntax-highlighting.js

[mathis-m]

@ghandic Actually I saw this comming when I submitted the RequestSnippets PR back then. This is currently not supported but can be implemented.
@char0n Shall I prepare a PR to provide SyntaxHighlighter to the plugin system so other languages can be registered later on?

[ghandic]

Is there anything I can help with on this?

[rsanvatsarkar]

@ghandic ,
Did you manage to get the other languages code snippets support working?
I tried adding "requestSnippets" generator but no luck. It only display the default cURL snippets. I would like to add the C#, JavaScript and Python language support. Please note that, I have take the latest css and the .js (swagger-ui-bundle, swagger-ui-standalone-preset). Any help would be greatly appreciated. Thank you.

const ui = SwaggerUIBundle({
urls:
@(Html.Raw(JsonConvert.SerializeObject(_servicesConfig.Services.Select(c => new { url = c.Url.ToString(), name = c.Name }), Formatting.Indented))),
"urls.primaryName": "@(_servicesConfig.Services.SingleOrDefault(c => c.Default)?.Name ?? _servicesConfig.Services.FirstOrDefault()?.Name)",
dom_id: '#swagger-ui',
deepLinking: true,
requestInterceptor: function (req)
{
req.mode = 'cors';
return req
},
validatorUrl: null,
presets: [
SwaggerUIBundle.presets.apis,
SwaggerUIStandalonePreset
],
plugins: [
SwaggerUIBundle.plugins.DownloadUrl
],
layout: "StandaloneLayout",
defaultModelsExpandDepth: -1,
requestSnippetsEnabled: true,
requestSnippets: {
generators: {
curl_bash: {
title: "cURL (bash)",
syntax: "bash"
},
curl_powershell: {
title: "cURL (PowerShell)",
syntax: "powershell"
},
curl_cmd: {
title: "cURL (CMD)",
syntax: "bash"
},
csharp_restsharp: {
title: "* C# - restsharp",
syntax: "csharp"
},
"node_native": {
title: "NodeJs Native",
syntax: "javascript"
}
},
defaultExpanded: true,
languages: ["curl_bash", "curl_powershell", "curl_cmd", "csharp_restsharp", "node_native]
},
showExtensions: true,
showCommonExtensions: true
})

[ghandic]

Please format your code, did you try using the above examples?

[rsanvatsarkar]

@ghandic , the code that I have pasted above is my code which is not working. I am once again attaching my code below. Please note that. I have taken the most recent swagger-ui-bundle.js, swagger-ui-standalone-preset.js and the CSS files but it doesn't work. I always see the default cURL code snippets and I am looking to add C#, JavaScript, Python and Ruby code snippets.

const ui = SwaggerUIBundle({
urls:
@(Html.Raw(JsonConvert.SerializeObject(_servicesConfig.Services.Select(c => new { url = c.Url.ToString(), name = c.Name }), Formatting.Indented))),
"urls.primaryName": "@(_servicesConfig.Services.SingleOrDefault(c => c.Default)?.Name ?? _servicesConfig.Services.FirstOrDefault()?.Name)",
dom_id: '#swagger-ui',
deepLinking: true,
requestInterceptor: function (req)
{
req.mode = 'cors';
return req
},
validatorUrl: null,
presets: [
SwaggerUIBundle.presets.apis,
SwaggerUIStandalonePreset
],
plugins: [
SwaggerUIBundle.plugins.DownloadUrl
],
layout: "StandaloneLayout",
defaultModelsExpandDepth: -1,
requestSnippetsEnabled: true,
requestSnippets: {
generators: {
curl_bash: {
title: "cURL (bash)",
syntax: "bash"
},
curl_powershell: {
title: "cURL (PowerShell)",
syntax: "powershell"
},
curl_cmd: {
title: "cURL (CMD)",
syntax: "bash"
},
csharp_restsharp: {
title: "* C# - restsharp",
syntax: "csharp"
},
"node_native": {
title: "NodeJs Native",
syntax: "javascript"
}
},
defaultExpanded: true,
languages: ["curl_bash", "curl_powershell", "curl_cmd", "csharp_restsharp", "node_native]
},
showExtensions: true,
showCommonExtensions: true
})

[mikenerone]

@ghandic Did your proposed changes (or something analogous to them to your knowledge) ever make it into FastAPI? I'd love to have the other language snippets available, but not strongly enough that I want to add code/maintenance into my project for it. I'm looking for something in a more ready-to-use form.