Extracts texts for localization from OpenAPI specification.
apigenie i18n [OPTIONS] FILE
This command extracts texts suitable for translations, from an OpenAPI documents. Extracted texts are written in key-value files, where keys are JSON pointers to locations in the input file, and values are literals located pointed to by keys.
Example:
apigenie i18n --output i18n-en.json openapi-in.yaml
may produce the following output:
/info/title: My API
/info/contact/name: My Team
The command extracts the following properties:
| Object | Properties |
|---|---|
Info | title, summary, description |
Contact | name |
License | name |
Server | description |
ServerVariable | description |
PathItem | summary, description |
Schema | title, description |
Response | description |
Parameter | description |
Example | summary, description |
RequestBody | description |
Header | description |
SecurityScheme | description |
Link | description |
Operation | summary, description |
ExternalDocumentation | description |
Tag | description |
Name of the file with extracted texts. Format of the file is determined by its
extension, which can be either .json or .yaml. Other extenstions will
result in error.