flasgger/flasgger
Flasgger
Flasgger is a documentation framework for Flask applications that generates OpenAPI specifications and an integrated Swagger UI. It functions as a documentation generator and specification parser that extracts API schemas from route definitions, function docstrings, and external specification files.
The tool allows API definitions to be maintained either within the source code using YAML blocks in docstrings or decoupled into standalone YAML files. It provides a browser-based interactive console for testing and exploring API endpoints directly from the web application.
Beyond documentation, the project handles API request validation by checking incoming request bodies and parameters against defined schemas. It supports runtime evaluation of specification values through lazy strings and allows the integration of external schema libraries for defining request and response structures.
The visual presentation of the documentation interface can be modified by overwriting default HTML templates and loading external assets.
Features
- API Documentation Generators - Automatically generates OpenAPI specifications and an interactive Swagger UI from docstrings and external files.
- Flask API Documentation - Generates OpenAPI specifications and an integrated Swagger UI specifically for Flask applications using docstrings or external files.
- API Specification Extraction - Automatically generates OpenAPI specifications by parsing YAML blocks within function docstrings.
- Interactive API Explorers - Provides a browser-based interactive console to test and explore API endpoints without writing client code.
- External API Specification Files - Imports API definitions from standalone YAML files to decouple documentation from application source code.
- External Specification Loading - Imports API specifications from external YAML files or dictionaries to separate documentation from application logic.
- OpenAPI Specification Management - Facilitates the creation and maintenance of standardized API contracts using YAML files or dictionaries.
- OpenAPI Specification Parsers - Parses function docstrings and YAML files into standardized OpenAPI schemas for validation and UI display.
- API Documentation Hosting - Embeds a visual interface to browse and test API resources directly from a web browser.
- API Documentation Tools - Functions as a documentation framework that extracts API schemas from Flask route definitions and external files.
- API Specification Generation - Produces machine-readable OpenAPI specifications from code, including support for components and callbacks.
- Flask Integrations - Integrates a Swagger UI web interface into the Flask environment for browsing and testing API endpoints.
- Interactive API Documentation UIs - Integrates a visual browser for interacting with API endpoints based on generated technical specifications.
- Request Schema Validators - Checks incoming request bodies and parameters against OpenAPI schemas to ensure data integrity.
- OpenAPI Specification Generators - Automatically derives OpenAPI specifications from registered views using docstrings, external files, or schema libraries.
- API Schema Retrieval - Extracts defined schemas from specifications as dictionaries for use within application logic.
- Schema Validation Libraries - Integrates external schema libraries to define API structures and automate documentation generation.
- Automatic Documentation Parsing - Scans directories for YAML files to automatically load API documentation based on endpoint and method names.
- Dynamic Specification Values - Resolves specification values at runtime using lazy strings to inject request context or database state.
- Swagger Document Validators - Embeds a visual Swagger UI to allow interactive testing of API resources directly in the browser.
- Validation Error Customizations - Defines custom handlers for data validation failures to return specific error messages or HTTP status codes.
- Validation Error Handlers - Provides custom handlers to intercept validation failures and return tailored error responses.
- API Frameworks - Swagger and OpenAPI documentation generator for Flask.
