What is Axe API?
Axe API is a TypeScript-based framework specifically designed to streamline the development of Rest APIs by enforcing best practices and eliminating common pitfalls. It automatically generates API endpoints based on model definitions, handles routes, and processes requests according to declarative configurations. The framework supports major relational database management systems (RDBMS) including PostgreSQL, MSSQL, MySQL, MariaDB, Oracle, and Amazon Redshift.
It provides features such as hooks for adding business logic, robust query capabilities like sorting and field selection, schema analysis to compare models with the database, and auto-documentation that updates based on model definitions and database schema. Axe API aims to reduce inconsistencies, stale documentation, and development time by offering a structured approach to API creation.
Features
- Model Definitions: Define models, validations, relations, and middlewares declaratively to build APIs quickly
- Routes Handling: Automatically creates and processes all API endpoints based on model definitions
- Hooks: Add business logic to API endpoints in a test-friendly manner
- Robust Queries: Includes features like sorting, selecting fields, and querying data at no extra cost
- Schema Analyzing: Analyzes database schema during initialization to compare with models
- Auto Documentation: Generates documentation automatically from model definitions, table relations, and database schema
Use Cases
- Building consistent and well-documented Rest APIs for web applications
- Developing backend services with automatic endpoint generation and validation
- Creating APIs that require robust querying capabilities and database integration
- Streamlining API development for teams to enforce best practices and reduce errors
FAQs
-
What databases does Axe API support?
Axe API supports major RDBMS including PostgreSQL, MSSQL, MySQL, MariaDB, Oracle, and Amazon Redshift. -
Does Axe API automatically generate API documentation?
Yes, Axe API creates auto-documentation by analyzing model definitions, table relations, and database schema. -
How does Axe API handle business logic in APIs?
Axe API uses hooks to add business logic to API endpoints in a test-friendly way.
