OpenAPI Free
ByCrowdinVerified Author

API reference files localization

Install

OpenAPI translation with Crowdin

Copy link

OpenAPI / Swagger files translation in Crowdin. Both YML and JSON formats are supported. The plugin has been tested with all major and widely used versions of the specification.

File Format Details

Copy link
Attribute Value
File Extension .json, .yml, .yaml
API Type openapi
Source can be edited in Crowdin No
Generating translated files via Bundles Search Crowdin Store
Supports pluralization No
WYSIWYG Preview in the editor Yes
Supported types of contextual information WYSIWYG
Custom attributes No
Existing translations import possibility Key-value mapping (trivial)

Sample File

Copy link
{
  "openapi": "3.1.0",
  "info": {
    "title": "Non-oAuth Scopes example",
    "version": "1.0.0"
  },
  "paths": {
    "/users": {
      "get": {
        "security": [
          {
            "bearerAuth": [
              "read:users",
              "public"
            ]
          }
        ]
      }
    }
  },
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "jwt",
        "description": "note: non-oauth scopes are not defined at the securityScheme level"
      }
    }
  }
}

Translating OpenAPI

Copy link

Note: YAML files will lose comments in translated files. Formatting will not be preserved either. This will not influence files rendering, your API documentation will look as original with just texts translated.

Crowdin is a platform that helps you manage and translate content into different languages. Integrate Crowdin with your repo, CMS, or other systems. Source content is always up to date for your translators, and translated content is returned automatically.

Learn More
Categories
File Formats
Development
Works with
  • Crowdin Enterprise
  • crowdin.com
Details

Released on Aug 20, 2022

Updated on Feb 23, 2024

Published by Crowdin

Identifier:openapi