ThorAPI Code Generator
Revolutionizing Backend + Frontend Integration
Welcome to the comprehensive documentation for ThorAPI, a cutting-edge solution designed to streamline the development process by automating the generation of TypeScript client libraries from your backend services. ThorAPI empowers developers to build faster, better, and more robust applications by simplifying the complexities of API integration.
Overview
ThorAPI is engineered to bridge the gap between backend and frontend development, offering a seamless experience through automatically generated TypeScript client libraries. By leveraging OpenAPI specifications, ThorAPI ensures that your frontend applications can effortlessly communicate with your backend services, reducing development time and minimizing integration errors.
Key Benefits of ThorAPI
- Accelerated Development Cycles: Automatically generate client libraries, eliminating the need for manual coding and reducing time-to-market.
- Enhanced Code Quality: Ensure type safety and consistency between your frontend and backend with generated TypeScript code.
- Simplified API Integration: Easily integrate your frontend with backend services, reducing complexity and potential integration issues.
- Comprehensive Documentation: Benefit from well-structured and automatically updated documentation, making it easier for developers to understand and use your APIs.
- Extensibility and Customization: Tailor ThorAPI to your specific needs with flexible configuration options and extension capabilities.
ThorAPI generates an opinionated FEBE (Front End / Back End) stack, along with comprehensive documentation. It is designed to be extensible, supporting the generation of client libraries in multiple languages through standard OpenAPI Code Generation libraries. The output is a production-ready Java Maven project for the backend and a fully functional TypeScript frontend library with React Redux store and component library.
Documentation Structure
This documentation is organized to provide you with a step-by-step guide to understanding, using, and contributing to ThorAPI:
- Overview of ThorAPI: Get a high-level understanding of ThorAPI's features, benefits, and use cases.
- Getting Started with ThorAPI: Learn how to set up and start using ThorAPI, including installation and authentication.
- CodeGen with ThorAPI: Explore the code generation capabilities of ThorAPI and how it simplifies the development process.
- Using ThorAPI-Generated Client Libraries: Understand how to use the generated TypeScript client libraries in your frontend applications.
- VAI Command Line Runner: Discover how to use the command-line runner for ThorAPI to streamline your workflow.
- Contributing to ThorAPI: Find out how you can contribute to the ThorAPI project and help improve it.
- Disclaimer for ThorAPI: Review the disclaimer regarding the use of ThorAPI and its documentation.
Further Reading
To deepen your understanding of the principles behind ThorAPI, consider exploring these resources:
- RESTful API Design: https://www.restapitutorial.com/ - Learn about RESTful API design principles, which ThorAPI leverages for seamless integration.
- OpenAPI Specification: https://swagger.io/specification/ - Understand the OpenAPI Specification, the foundation for ThorAPI's code generation capabilities.
- Best Practices in API Documentation: https://nordicapis.com/10-best-practices-for-api-documentation/ - Explore best practices for API documentation to appreciate the value ThorAPI brings in automated documentation generation.
Start exploring the documentation to unlock the full potential of ThorAPI and revolutionize your development workflow.