Overview

The Docusaurus OpenAPI docs plugin comes with support for 8 languages which you can render as code snippets on an API operation page. The languages currently supported are:

Language	Prism Highlighter	Variants
curl	bash	curl*
python	python	requests*, http.client
go	go	native*
nodejs	javascript	axios*, native
ruby	ruby	net::http*
csharp	csharp	restsharp*, httpclient
php	php	curl*, guzzle, pecl_http, http_request2
java	java	okhttp*, unirest
powershell	powershell	RestMethod*

* Default variant

The enabled languages are defined for your site in a languageTabs array in the themeConfig object in your config file. If you do not define this configuration item all of the languages above are enabled. The config schema for each language is as follows:

Name	Type	Default	Description
highlight	string	null	The syntax highlighting ruleset to use.
language	string	null	The programming language to use when generating the example.
logoClass	string	null	The CSS class to be added to render the appropriate logo.
variant	string	null	The language variant to use when generating the example, see below for a tip on where you can find the variants.
options	object	null	Optional: Set of options for language customization. See below for common options, exact options depend on language.
followRedirect	string	null	Optional: Follow redirects when handling requests.
trimRequestBody	string	null	Optional: Trim request body fields.
indentCount	integer	language dependent	Optional: Alter the number of indentations used when generating the examples.
indentType	string	language dependent	Optional: Alter the type of indentation used, Space or Tab are acceptable options for this.

tip

The order you define the languages under languageTabs is the order in which they will appear once rendered.

danger

Individual languages may only be defined once, meaning you cannot define a language multiple times with different variants. For example, you cannot define both nodejs\axios and nodejs\unirest or python/requests and python/http.client.

Demo Languages

The demo site disables the ruby and php languages using the following languageTabs config object.

      languageTabs: [
        {
          highlight: "bash",
          language: "curl",
          logoClass: "bash",
        },
        {
          highlight: "python",
          language: "python",
          logoClass: "python",
          variant: "requests",
        },
        {
          highlight: "go",
          language: "go",
          logoClass: "go",
        },
        {
          highlight: "javascript",
          language: "nodejs",
          logoClass: "nodejs",
          variant: "axios",
        },
        {
          highlight: "ruby",
          language: "ruby",
          logoClass: "ruby",
        },
        {
          highlight: "csharp",
          language: "csharp",
          logoClass: "csharp",
          variant: "httpclient",
        },
        {
          highlight: "php",
          language: "php",
          logoClass: "php",
        },
        {
          highlight: "java",
          language: "java",
          logoClass: "java",
          variant: "unirest",
        },
        {
          highlight: "powershell",
          language: "powershell",
          logoClass: "powershell",
        },
      ],