Skip to main content

CodeGen with ThorAPI: Build Faster, Better, Stronger Code Than Ever Before

In today's fast-paced software development environment, efficiency and code quality are paramount. Developers are constantly challenged to deliver high-quality applications rapidly, while also ensuring seamless integration with backend services. ThorAPI addresses these challenges head-on by providing powerful code generation capabilities that automate the creation of TypeScript client libraries and backend components, significantly accelerating the development lifecycle.

The Power of Code Generation​

Code generation is a transformative approach in software development that automates the creation of code based on predefined templates or specifications. This technique offers numerous advantages:

  • Increased Productivity: Automates repetitive coding tasks, freeing up developers to focus on complex business logic and innovative features.
  • Improved Code Quality: Generates consistent, well-structured, and error-free code, reducing the likelihood of bugs and improving maintainability.
  • Faster Time-to-Market: Accelerates development cycles by automating code creation, enabling quicker delivery of applications.
  • Enhanced Consistency: Ensures uniformity across the codebase, making it easier for teams to collaborate and maintain the project over time.
  • Reduced Integration Errors: Automatically generates client libraries that are perfectly aligned with backend APIs, minimizing integration issues and ensuring seamless communication.

According to a report by Evans Data Corporation, code generation tools can reduce development time by up to 40%, highlighting the significant impact of this technology on software development efficiency.

What Does ThorAPI Generate?​

ThorAPI is designed to generate a comprehensive FEBE (Front End / Back End) stack, along with supporting documentation, from a single OpenAPI specification. This holistic approach ensures that all aspects of API integration are streamlined and automated.

1. Opinionated FEBE Stack​

ThorAPI generates a complete, opinionated full-stack architecture, including:

  • Backend (Java Spring Boot): A production-ready Java Maven project built with Spring Boot, providing a robust and scalable backend foundation.
  • Frontend (TypeScript React Redux): A fully functional TypeScript frontend library with React components and a Redux store, ready to be consumed in your frontend applications.

This generated stack is designed to be immediately deployable and customizable, providing developers with a solid starting point for their projects.

2. Comprehensive Documentation​

ThorAPI automatically generates comprehensive documentation alongside the code, ensuring that the API is well-documented and easy to understand. This includes:

  • API Documentation: Automatically generated API documentation in formats like Swagger UI or ReDoc, providing interactive and user-friendly API references.
  • Project Documentation: Documentation for the generated backend and frontend projects, including setup instructions, architecture overviews, and usage examples.

3. Multi-Language Client Library Generation (Extensible)​

While ThorAPI primarily generates a TypeScript client library, it is designed to be extensible and can be configured to generate client libraries in various other languages via standard OpenAPI Code Generation libraries. This flexibility ensures that ThorAPI can adapt to diverse technology stacks and project requirements. Supported languages can include:

  • Python
  • Java
  • Go
  • C#
  • and more...

By leveraging OpenAPI Code Generation, ThorAPI can be extended to support virtually any programming language for which an OpenAPI generator exists.

ThorAPI Project Structure and Generated Output​

Here is a detailed overview of a ThorAPI project structure and its generated output:

.
|--- generated
|   |--- spring
|   |   |--- .openapi-generator-ignore            # Exclude files from generation
|   |   |--- pom.xml                              # Maven build file for Spring Boot project
|   |   |--- README.md                            # Backend project documentation
|   |   |--- src
|   |   |   |--- main
|   |   |   |   |--- resources
|   |   |   |   |   |--- openapi.yaml             # OpenAPI spec for API documentation
|   |   |   |   |   |--- application.yaml         # Spring Boot config file
|   |   |   |--- java
|   |   |   |   |--- com
|   |   |   |   |   |--- valkyrlabs               # Main package for business logic
|   |   |   |   |   |   |--- model                # Generated backend models
|   |   |   |   |   |   |--- api                  # Generated API Controllers
|--- pom.xml                                      # Main Maven build file
|--- README.md                                    # Main project documentation
|--- .gitignore                                   # Git exclusion rules
|--- .github                                      # CI/CD workflows (e.g., GitHub Actions)
|   |--- workflows
|--- src
|   |--- test
|   |   |--- resources
|   |   |   |--- openapi
|   |   |   |   |--- api.yaml                    # Test OpenAPI spec
|   |   |   |--- templates
|   |   |--- java
|   |   |   |--- com
|   |   |   |   |--- thorapi
|   |   |   |   |   |--- security
|   |   |   |   |   |--- data
|   |--- main
|   |   |--- typescript
|   |   |   |--- valkyr_labs_com                 # Main Typescript source directory
|   |   |   |   |--- docs                        # Frontend documentation
|   |   |   |   |   |--- valkyrai-getting-started.md
|   |   |   |   |   |--- valkyrai-overview.md
|   |   |   |   |--- .storybook                  # Storybook configuration for UI components
|   |   |   |   |--- src
|   |   |   |   |   |--- components             # Generated React components
|   |   |   |   |   |   |--- HomepageFeatures
|   |   |   |   |   |   |--- UserList
|   |   |   |   |   |   |--- ContentList
|   |   |--- public
|   |   |   |--- .gitignore
|   |   |   |--- static
|   |--- resources
|   |   |--- xxxs.xml                         # Cache configuration
|   |   |--- openapi
|   |   |   |--- api.yaml                         # Core OpenAPI spec for main API
|   |   |--- templates                            # Mustache templates for code generation
|   |   |   |--- typescript-redux-query
|   |   |   |   |--- apiREST.mustache             # REST API integration template
|   |   |   |   |--- modelService.mustache        # Model service template for Redux
|   |   |   |   |--- generator.config.yaml        # Code generation configuration
|   |   |   |--- JavaSpring
|   |   |   |   |--- model.mustache               # Spring Boot model template
|   |   |   |   |--- apiController.mustache       # Spring Boot API controller template
|   |   |   |   |--- pom.mustache                 # Template for the Maven pom.xml
|--- application.yaml                             # Main Spring Boot application configuration

Customization and Extension​

ThorAPI is designed to be highly customizable and extensible. Developers can tailor the code generation process to meet specific project requirements by:

  • Modifying Templates: Customize the Mustache templates to alter the generated code structure, style, and functionality.
  • Configuring OpenAPI Generator: Adjust the OpenAPI Generator configuration to fine-tune the code generation process and support additional languages or frameworks.
  • Extending Functionality: Add custom code and logic to the generated projects to implement specific business requirements and enhance the generated codebase.

Get Started with Code Generation​

Ready to experience the power of code generation with ThorAPI? Refer to the Getting Started with ThorAPI guide to begin generating your own FEBE stacks and client libraries.

For further reading on code generation and OpenAPI specifications, explore these resources:

Unleash the full potential of ThorAPI's code generation capabilities and transform your development workflow today!