https://github.com/dataforseo/dataforseoclientsgenerator
https://github.com/dataforseo/dataforseoclientsgenerator
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/dataforseo/dataforseoclientsgenerator
- Owner: dataforseo
- License: mit
- Created: 2025-07-22T13:29:29.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-09-24T15:33:02.000Z (9 months ago)
- Last Synced: 2025-10-06T19:26:52.393Z (9 months ago)
- Language: Liquid
- Size: 135 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# DataForSeo Clients Generator
A OpenAPI-based code generator that creates client libraries for DataForSeo API in multiple programming languages.
## Overview
DataForSeo Clients Generator is a .NET-based tool that automatically generates client SDK libraries for the DataForSeo API using OpenAPI specifications. It supports multiple programming languages and provides type-safe, well-documented client libraries that make it easy to integrate with DataForSeo services.
## Supported Languages
- **C# (.NET)**
- **Java**
- **TypeScript**
- **Python**
## Getting Started
The easiest way to generate client libraries is through the **Console application** (`OpenApiGenerator.Console`), which serves as the main entry point for the code generator.
### Command Line Options
The Console application supports the following command-line options:
```bash
cd OpenApiGenerator.Console
dotnet run -c Release -- [options]
```
**Available Options:**
- `--languages` - Programming languages to generate code for (comma-separated)
- Available: `CSharp`, `Java`, `Python`, `TypeScript`
- Default: All languages
- Example: `--languages CSharp Python`
- `--doc` - Path to the OpenAPI YAML specification file
- Default: Downloads from official DataForSeo GitHub [repository](https://github.com/dataforseo/OpenApiDocumentation)
- Example: `--doc C:\path\to\openapi.yaml`
- `--out` - Output root path for generated client libraries
- Default: Executing directory
- Example: `--out C:\Generated\Clients`
- `--login` - DataForSeo API username for configuration test classes to fetch data from api
- Default: username
- Example: `--login your-username`
- `--password` - DataForSeo API password for test configuration test classes to fetch data from api
- Default: password
- Example: `--password your-password`
### Usage Examples
**Generate all client libraries with default settings:**
```bash
dotnet run -c Release
```
**Generate only C# and Python clients:**
```bash
dotnet run -c Release -- --languages CSharp Python --out D:\MyClients
```
**Generate with custom OpenAPI file and credentials:**
```bash
dotnet run -c Release -- --doc D:\api\openapi.yaml --login myuser --password mypass --out C:\Output
```
The generator will automatically create appropriate project structures, dependencies, and test configurations for each selected language.
## License
This project is licensed under the [MIT License](LICENSE).