hugapi/hug
Hug
Hug is a Python API framework used for building web services by mapping functions to HTTP endpoints via decorators and type annotations. It functions as a type-based validator that automatically converts and validates incoming request data based on Python type hints and serves as a WSGI-compliant web framework for deployment on production servers.
The project is distinguished by its ability to automatically generate API specifications and user-facing documentation derived from function signatures. It further extends the utility of internal logic by exposing functions as terminal commands through an integrated command line interface generator.
The framework covers a broad range of capabilities including asynchronous request handling, API versioning via URL paths and headers, and content negotiation for transforming responses into formats like JSON, XML, or HTML. It also provides tools for middleware-based request interception, modular API composition, and response streaming for large payloads.
The framework includes a development server with automatic source code reloading and provides utilities for simulating HTTP requests to validate endpoints without a live server.
Features
- RESTful API Development - Provides a framework for building RESTful web services by mapping Python functions to network endpoints.
- WSGI Frameworks - Provides a WSGI-compliant web framework for building and deploying APIs on production servers.
- Automatic Specification Generators - Automatically derives API specifications and user-facing documentation from function signatures and type annotations.
- API Documentation Generators - Automatically generates API specifications and user-facing documentation based on function signatures and type hints.
- Type-Annotation Validation - Uses Python type annotations to automatically validate and convert incoming request data into specified types.
- API Endpoint Definitions - Allows defining and exposing network endpoints using a structured framework to simplify web service development.
- Function-to-URL Mappings - Uses decorators to map internal Python functions directly to network endpoints and HTTP methods.
- Asynchronous Request Handlers - Handles high volumes of concurrent traffic by executing request handlers as non-blocking asynchronous coroutines.
- Asynchronous Web Frameworks - Provides a high-performance server foundation built on non-blocking execution for concurrent request processing.
- Python Web Frameworks - Functions as a comprehensive Python web framework for building APIs using decorators and type annotations.
- Request Routing - Associates specific URL paths and HTTP methods with handler functions to process incoming web requests.
- Decorator-Based Route Mappings - Uses function decorators to associate internal logic with HTTP methods and URL paths.
- Output Format Rendering - Transforms API responses into JSON, HTML, or XML based on the requested content type.
- Automatic CLI Generators - Automatically synthesizes command line interfaces by exposing internal functions as terminal commands.
- Directive-Based State Injections - Pipes transformed request data into handler functions using specialized parameter markers during the request cycle.
- API Request Authentication - Verifies user identity using token-based authentication or API key header checks to protect endpoints.
- Asynchronous Execution - Implements non-blocking request handlers using asynchronous coroutines to manage concurrent network traffic.
- Extensibility Frameworks - Allows integrating custom types, authentication methods, and middleware through a flexible extensibility framework.
- Simulated Request Testing - Simulates HTTP requests to defined routes to validate status codes and response data without a live server.
- Command-Line Interface Development - Exposes internal application logic as terminal commands that accept arguments and return formatted output.
- API Versioning - Supports API versioning via URL paths and HTTP headers by assigning version ranges to endpoints.
- Modular Routing Systems - Organizes large projects by mapping imported modules to specific URL paths for better structure.
- Content Negotiation Utilities - Transforms return values into JSON, XML, or HTML based on the client's requested content type.
- Modular API Composition - Allows organizing large services by mounting separate functional modules to specific base URL paths.
- Request and Response Transformers - Processes request bodies and transforms return values into specific transport formats based on the requested content type.
- Directive-Based Injections - Pipes transformed request data or external values into functions using specialized directives as input parameters.
- Request Data Transformation - Executes custom directive functions to process or inject data into handlers based on request parameters.
- Request Middleware - Provides middleware to intercept and process HTTP requests before they reach the application controllers.
- Request-Response Interceptors - Provides middleware to intercept requests and responses globally to modify environment data or headers.
- Response Formatting - Applies custom formatting functions to the results of API calls before sending data to the client.
- WSGI Application Servers - Implements a standard WSGI interface to ensure compatibility with production servers like Gunicorn or uWSGI.
- WSGI-Based Request Handling - Implements a WSGI-compliant interface allowing the application to be mounted within other request cycles.
- API Frameworks - Framework for building clean, public-facing APIs.
