Releases: Hyperspan/Hyperspan.Base.Api
Restructure
What's Changed
- Project restructured by @AyushAher in #6
Appropriate Projects added to the solution:
Domain
For managing all the database and entity framework functionalityInfrastructure
For managing all custom services, interfaces and overall business logic of the applicationApi
for API gateway to accept requestsShared
for common classes and functionality that is being used through out the applicationUI
a basic vite React + TS project with minimal setup for Redux and Axios.
Full Changelog: v1.1.1...v1.2
v1.1.1
Hyperspan.Api v1.1.1 Release Notes
Overview
Hyperspan.Api v1.0.0 marks the initial release of the project template designed to expedite API development, incorporating fundamental authentication and authorization mechanisms, including the utilization of Identity Framework. This release provides a structured foundation built to interface with Postgres databases seamlessly.
Key Features
- Basic Authentication: Implements a straightforward authentication system ensuring secure access to the API endpoints.
- Authorization Support: Enables controlled access and authorization to different parts of the API based on user roles or permissions.
- Postgres Integration: Seamlessly integrates with Postgres databases for efficient data storage and retrieval.
- Identity Framework Integration: Incorporates Identity Framework for user authentication, user management, and role-based access control.
- Override Functionality: Override any existing functionality as almost every method is virtual and can be overridden as per requirements.
Highlights
- API Structure: Includes a well-organized API structure to enhance development clarity and maintainability.
- Security Enhancements: Employs secure practices to safeguard sensitive data and prevent unauthorized access.
- Modular Design: Utilizes a modular design approach for ease of scalability and future enhancements.
- Documentation: Provides comprehensive documentation for easier onboarding and understanding of the API functionalities.
What's Changed
- Expanded Authentication Methods
- Enhanced Authorization Controls
Full Changelog: v1.0.0...v1.1.1
Upcoming Improvements
Future iterations of Hyperspan.Api are anticipated to include:
- Optimization for Performance
- Multiple Database support like
MySQL
SQL Server
Sql-lite
Getting Started
Developers can begin utilizing Hyperspan.Api v1.0.0 by following the provided documentation available within the project repository. This includes instructions on setting up the environment, configuring authentication, understanding Identity Framework integration, and exploring the API endpoints.
For detailed information and usage instructions, refer to the documentation within the project repository.
How to Contribute
We encourage developers to contribute to the project by:
- Reporting any issues or bugs encountered while using the API.
- Suggesting enhancements or additional features.
- Collaborating on improvements via pull requests.
Bug Fixes and Known Issues
At this release stage, there are no reported bugs. Please refer to the issue tracker for any updates on known issues or fixes.
Notes
Hyperspan.Api v1.0.0 sets the groundwork for a robust API template with basic authentication and authorization features, coupled with Postgres database integration and Identity Framework utilization. It aims to streamline API development while ensuring security and ease of use for developers.
For detailed information, consult the documentation within the project repository.
Thank you for choosing Hyperspan.Api. We appreciate your feedback and contributions to further enhance this project.
V1.0.0
Hyperspan.Api v1.0.0 Release Notes
Overview
Hyperspan.Api v1.0.0 marks the initial release of the project template designed to expedite API development, incorporating fundamental authentication and authorization mechanisms, including the utilization of Identity Framework. This release provides a structured foundation built to interface with Postgres databases seamlessly.
Key Features
- Basic Authentication: Implements a straightforward authentication system ensuring secure access to the API endpoints.
- Authorization Support: Enables controlled access and authorization to different parts of the API based on user roles or permissions.
- Postgres Integration: Seamlessly integrates with Postgres databases for efficient data storage and retrieval.
- Identity Framework Integration: Incorporates Identity Framework for user authentication, user management, and role-based access control.
- Override Functionality: Override any existing functionality as almost every method is virtual and can be overridden as per requirements.
Highlights
- API Structure: Includes a well-organized API structure to enhance development clarity and maintainability.
- Security Enhancements: Employs secure practices to safeguard sensitive data and prevent unauthorized access.
- Modular Design: Utilizes a modular design approach for ease of scalability and future enhancements.
- Documentation: Provides comprehensive documentation for easier onboarding and understanding of the API functionalities.
Upcoming Improvements
Future iterations of Hyperspan.Api are anticipated to include:
- Expanded Authentication Methods
- Enhanced Authorization Controls
- Optimization for Performance
- Multiple Database support like
MySQL
SQL Server
Sql-lite
Getting Started
Developers can begin utilizing Hyperspan.Api v1.0.0 by following the provided documentation available within the project repository. This includes instructions on setting up the environment, configuring authentication, understanding Identity Framework integration, and exploring the API endpoints.
For detailed information and usage instructions, refer to the documentation within the project repository.
How to Contribute
We encourage developers to contribute to the project by:
- Reporting any issues or bugs encountered while using the API.
- Suggesting enhancements or additional features.
- Collaborating on improvements via pull requests.
Bug Fixes and Known Issues
At this release stage, there are no reported bugs. Please refer to the issue tracker for any updates on known issues or fixes.
Notes
Hyperspan.Api v1.0.0 sets the groundwork for a robust API template with basic authentication and authorization features, coupled with Postgres database integration and Identity Framework utilization. It aims to streamline API development while ensuring security and ease of use for developers.
For detailed information, consult the documentation within the project repository.
Thank you for choosing Hyperspan.Api. We appreciate your feedback and contributions to further enhance this project.