restcodegen 1.2.0

No project description provided

RestCodeGen

Generate Python clients from OpenAPI specifications with ease

🚀 Overview

RestCodeGen is a powerful tool for automatically generating Python client libraries from OpenAPI 3 specifications. It streamlines the process of interacting with REST APIs, allowing developers and testers to quickly integrate with services that provide OpenAPI documentation.

✨ Key Features

• Easy Client Generation: Create Python clients with a single command
• Async Support: Generate both synchronous and asynchronous clients
• Selective API Generation: Choose specific API tags to include
• Built-in Logging: Integrated with structlog for comprehensive request/response tracking
• Customizable: Use your own HTTPX client for advanced configurations
• Type Hints: All generated code includes proper type annotations

📦 Installation

RestCodeGen requires Python 3.10 or higher. Install it using pip:

pip install restcodegen

Or with Poetry:

poetry add restcodegen

🔧 Usage

Basic Command

restcodegen generate -u "http://example.com/openapi.json" -s "my-service" -a false

Command Parameters

Parameter	Short	Description	Required	Default
--url	-u	URL of the OpenAPI specification	Yes	-
--service-name	-s	Name of the service	Yes	-
--async-mode	-a	Enable asynchronous client generation	No	false
--api-tags	-t	Comma-separated list of API tags to generate	No	All APIs
--templates-dir	-td	Path to directory with custom Jinja2 templates	No	Built-in templates
--output-dir	-o	Output directory for generated clients (root package path)	No	./clients/http

Example

Examples

Generate a client for the Petstore API with default templates:

restcodegen generate -u "https://petstore3.swagger.io/api/v3/openapi.json" -s "petstore" -a false

Generate a client using custom templates:

restcodegen generate -u "https://petstore3.swagger.io/api/v3/openapi.json" -s "petstore" -a false -td ./custom_templates

Generate a client into a custom output directory (imports will follow this base path):

restcodegen generate -u "https://petstore3.swagger.io/api/v3/openapi.json" -s "petstore" -o framework/internal

Custom Templates

You can provide your own Jinja2 templates to customize the generated code. Place your template files in a directory and specify the path using the --templates-dir (-td) option. The following template files are supported:

• api_client.jinja2 - Main API client template
• header.jinja2 - File header template (for license and imports)
• apis_init.jinja2 - Data model template

To customize the output, copy the default templates from the package's templates directory and modify them as needed.

Output Directory and Imports

When you specify --output-dir (-o), the generated package structure is created under that directory, for example:

framework/
  internal/
    petstore/
      apis/
      models/

All generated imports are based on the base path you provide (e.g. framework.internal.petstore...). If -o is not provided, the default base path is clients/http.

📁 Generated Structure

After successful execution, a client library will be created with the following structure:

└── clients                      
     └── http     
        ├── schemas               # OpenAPI 3.0.0 schemas for all generated APIs                   
        └── service_name          # Service name     
            ├── apis              # API client classes                    
            └── models            # Pydantic models   

💻 Using the Generated Client

The generated client includes built-in logging with structlog and supports custom HTTPX clients:

from restcodegen.restclient import Client, Configuration
from clients.http.petstore import PetApi
import structlog

# Configure logging
structlog.configure(
    processors=[
        structlog.processors.JSONRenderer(
            indent=4,
            ensure_ascii=True,
        )
    ]
)

# Create and use the client
if __name__ == '__main__':
    # Configure the base URL
    configuration = Configuration(host="https://petstore3.swagger.io/api/v3")
    
    # Use the built-in client
    api_client = Client(configuration)
    
    # Or use your custom HTTPX client
    # import httpx
    # api_client = httpx.Client()  # or httpx.AsyncClient() for async mode
    
    # Initialize the API
    pet_api = PetApi(api_client)
    
    # Make API calls
    response = pet_api.get_pet_pet_id(pet_id=1)
    print(response)

🔄 Development Workflow

1. Install development dependencies:

   poetry install
   

2. Run tests:

   poetry run pytest
   

3. Check code quality:

   poetry run ruff check .
   poetry run mypy .
   

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

---

🤝 Contributing

Contributions are welcome! Feel free to open issues or submit pull requests.

📬 Contact

For questions or feedback, please open an issue in the repository.

---

RestCodeGen - Making API integration simple and efficient