fastopenapi
FastOpenAPI is a library for generating and integrating OpenAPI schemas using Pydantic v2 and various frameworks (AioHttp, Django, Falcon, Flask, Quart, Sanic, Starlette, Tornado).
File Explorer
Download Latest Version (.zip)- action.yml
- bug_report.yml
- feature_request.yml
- docs.yml
- master-deploy.yml
- master.yml
- test-deploy.yml
- test.yml
- CODE_OF_CONDUCT.md
- CONTRIBUTING.md
- PULL_REQUEST_TEMPLATE.md
- SECURITY.md
- AIOHTTP.md
- pure.py
- with_fastopenapi.py
- with_validators.py
- __init__.py
- benchmark_base.py
- schemas.py
- storage.py
- DJANGO.md
- pure.py
- with_fastopenapi.py
- with_validators.py
- FALCON.md
- pure.py
- with_fastopenapi.py
- with_validators.py
- run.py
- FLASK.md
- pure.py
- with_fastopenapi.py
- with_validators.py
- pure.py
- QUART.md
- with_fastopenapi.py
- with_validators.py
- pure.py
- SANIC.md
- with_fastopenapi.py
- with_validators.py
- pure.py
- STARLETTE.md
- with_fastopenapi.py
- with_validators.py
- pure.py
- TORNADO.md
- with_fastopenapi.py
- with_validators.py
- benchmark.py
- README.md
- architecture.md
- architecture_quick_reference.md
- custom_routers.md
- openapi_customization.md
- performance.md
- testing.md
- dependencies.md
- errors.md
- parameters.md
- responses.md
- routers.md
- types.md
- changelog.md
- contributing.md
- faq.md
- async_tasks.md
- authentication.md
- crud_api.md
- file_uploads.md
- multi_router.md
- aiohttp.md
- django.md
- falcon.md
- flask.md
- overview.md
- quart.md
- sanic.md
- starlette.md
- tornado.md
- core_concepts.md
- installation.md
- quickstart.md
- dependencies.md
- error_handling.md
- request_body.md
- request_parameters.md
- response_handling.md
- routing.md
- security.md
- validation.md
- favicon.png
- HelloRedoc.jpg
- HelloSwagger.jpg
- mermaid-init.js
- index.md
- __init__.py
- authors.py
- posts.py
- __init__.py
- routes.py
- __init__.py
- authors.py
- posts.py
- __init__.py
- authors.py
- posts.py
- __init__.py
- storage.py
- run.py
- __init__.py
- authors.py
- posts.py
- __init__.py
- routes.py
- __init__.py
- authors.py
- posts.py
- __init__.py
- authors.py
- posts.py
- __init__.py
- settings.py
- storage.py
- urls.py
- wsgi.py
- manage.py
- __init__.py
- authors.py
- posts.py
- __init__.py
- routes.py
- __init__.py
- authors.py
- posts.py
- __init__.py
- authors.py
- posts.py
- __init__.py
- storage.py
- run.py
- __init__.py
- authors.py
- posts.py
- __init__.py
- routes.py
- __init__.py
- authors.py
- posts.py
- __init__.py
- authors.py
- posts.py
- __init__.py
- storage.py
- run.py
- __init__.py
- authors.py
- posts.py
- __init__.py
- routes.py
- __init__.py
- authors.py
- posts.py
- __init__.py
- authors.py
- posts.py
- __init__.py
- storage.py
- run.py
- __init__.py
- authors.py
- posts.py
- __init__.py
- routes.py
- __init__.py
- authors.py
- posts.py
- __init__.py
- authors.py
- posts.py
- __init__.py
- storage.py
- run.py
- __init__.py
- authors.py
- posts.py
- __init__.py
- routes.py
- __init__.py
- authors.py
- posts.py
- __init__.py
- authors.py
- posts.py
- __init__.py
- storage.py
- run.py
- __init__.py
- authors.py
- posts.py
- __init__.py
- routes.py
- __init__.py
- authors.py
- posts.py
- __init__.py
- authors.py
- posts.py
- __init__.py
- storage.py
- run.py
- aiohttp_example.py
- django_example.py
- falcon_example.py
- flask_example.py
- quart_example.py
- sanic_example.py
- starlette_example.py
- tornado_example.py
- __init__.py
- constants.py
- dependency_resolver.py
- params.py
- router.py
- types.py
- __init__.py
- exceptions.py
- types.py
- __init__.py
- generator.py
- ui.py
- __init__.py
- profile.py
- resolver.py
- __init__.py
- builder.py
- serializer.py
- __init__.py
- async_router.py
- extractors.py
- __init__.py
- async_router.py
- extractors.py
- sync_router.py
- __init__.py
- async_router.py
- extractors.py
- sync_router.py
- __init__.py
- extractors.py
- sync_router.py
- __init__.py
- async_router.py
- extractors.py
- __init__.py
- async_router.py
- extractors.py
- __init__.py
- async_router.py
- extractors.py
- __init__.py
- async_router.py
- extractors.py
- handler.py
- utils.py
- __init__.py
- base.py
- common.py
- extractors.py
- __init__.py
- __version__.py
- error_handler.py
- py.typed
- __init__.py
- test_base_router.py
- test_dependency_resolver.py
- test_params.py
- test_types.py
- __init__.py
- test_exceptions.py
- __init__.py
- apps.py
- clients.py
- conftest.py
- test_async_endpoints.py
- test_body_semantics.py
- test_content_types.py
- test_cookies_headers.py
- test_crud.py
- test_dependencies.py
- test_docs.py
- test_errors.py
- test_forms.py
- test_head_status.py
- test_json_body.py
- test_multipart.py
- test_query_params.py
- test_smoke.py
- utils.py
- __init__.py
- test_openapi_generator.py
- test_ui.py
- __init__.py
- test_extraction_profile.py
- test_parameter_resolver.py
- __init__.py
- test_response_builder.py
- test_response_serializer.py
- __init__.py
- test_aiohttp_router.py
- __init__.py
- conftest.py
- test_django_router.py
- __init__.py
- conftest.py
- test_django_router.py
- __init__.py
- __init__.py
- test_falcon_router.py
- __init__.py
- test_falcon_extractor.py
- test_falcon_router.py
- __init__.py
- __init__.py
- test_flask_extractor.py
- test_flask_router.py
- __init__.py
- test_quart_extractor.py
- test_quart_router.py
- __init__.py
- test_sanic_router.py
- __init__.py
- test_starlette_router.py
- __init__.py
- test_dynamic_handler.py
- test_tornado_router.py
- __init__.py
- test_base_adapter.py
- test_docs_registration.py
- test_extractor_edges.py
- test_extractors.py
- __init__.py
- test_error_handler.py
- test_routers_import.py
- .coveragerc
- .flake8
- .gitignore
- .isort.cfg
- .pre-commit-config.yaml
- CHANGELOG.md
- CITATION.cff
- LICENSE
- logo.png
- mkdocs.yml
- poetry.lock
- pyproject.toml
- pytest.ini
- README.md
# Installation Guide
1. Get the code
git clone https://github.com/mr-fatalyst/fastopenapi
Downloads the entire project code from GitHub to your computer.
cd fastopenapi
Moves into the project folder you just downloaded.
2. Official Install Script
Easy RecommendedPrerequisites
- Python 3 Python is required to use pip.
pip install fastopenapi
Installs the package published on PyPI directly โ no need to clone the source.
pip install fastopenapi[aiohttp]
Installs the package published on PyPI directly โ no need to clone the source.
pip install fastopenapi[falcon]
Installs the package published on PyPI directly โ no need to clone the source.
pip install fastopenapi[flask]
Installs the package published on PyPI directly โ no need to clone the source.
After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.
Pulled directly from this repo's README.
3. Python
EasyPrerequisites
pip install fastopenapi
Installs the package published on PyPI directly โ no need to clone the source.
pip install fastopenapi[aiohttp]
Installs the package published on PyPI directly โ no need to clone the source.
pip install fastopenapi[falcon]
Installs the package published on PyPI directly โ no need to clone the source.
pip install fastopenapi[flask]
Installs the package published on PyPI directly โ no need to clone the source.
pip install fastopenapi[quart]
Installs the package published on PyPI directly โ no need to clone the source.
If it runs without errors and prints output in the terminal, it worked.
Pulled directly from this repo's README.
// repository documentation
Was this content helpful?
(0 ratings)