Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Tinche/uapi
https://github.com/Tinche/uapi
api python web
Last synced: 8 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/Tinche/uapi
- Owner: Tinche
- License: apache-2.0
- Created: 2021-09-29T23:50:06.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-02T16:38:34.000Z (2 months ago)
- Last Synced: 2024-10-14T12:17:32.983Z (27 days ago)
- Topics: api, python, web
- Language: Python
- Homepage: https://uapi.threeofwands.com
- Size: 857 KB
- Stars: 88
- Watchers: 5
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-python-web-frameworks - uapi - a high-level, extremely fast Python microframework for writing HTTP APIs, either synchronously or asynchronously. Uses a lower-level HTTP framework to run. Currently supported frameworks are aiohttp, Flask, Quart, and Starlette. (Micro-frameworks / More)
README
# uapi
[](https://uapi.threeofwands.com)
[](https://github.com/Tinche/uapi/blob/main/LICENSE)
[](https://pypi.python.org/pypi/uapi)
[](https://github.com/Tinche/uapi)
[](https://github.com/Tinche/uapi/actions/workflows/main.yml)
_uapi_ is an elegant, high-level, extremely low-overhead Python microframework for writing HTTP APIs, either synchronously or asynchronously.
_uapi_ uses a lower-level HTTP framework to run. Currently supported frameworks are aiohttp, Django, Flask, Quart, and Starlette.
An _uapi_ app can be easily integrated into an existing project based on one of these frameworks, and a pure _uapi_ project can be easily switched between them when needed.
Using _uapi_ enables you to:
- write **either async or sync** styles of handlers, depending on the underlying framework used.
- use and customize a [**function composition** (dependency injection) system](https://uapi.threeofwands.com/en/stable/composition.html), based on [incant](https://incant.threeofwands.com).
- automatically **serialize and deserialize** data through [attrs](https://www.attrs.org) and [cattrs](https://catt.rs).
- generate and use [**OpenAPI**](https://uapi.threeofwands.com/en/stable/openapi.html) descriptions of your endpoints.
- optionally **type-check** your handlers with [Mypy](https://mypy.readthedocs.io/en/stable/).
- write and use reusable and [**powerful middleware**](https://uapi.threeofwands.com/en/stable/addons.html), which integrates into the OpenAPI schema.
- **integrate** with existing apps based on [Django](https://docs.djangoproject.com/en/stable/), [Starlette](https://www.starlette.io/), [Flask](https://flask.palletsprojects.com), [Quart](https://pgjones.gitlab.io/quart/) or [aiohttp](https://docs.aiohttp.org).
Here's a simple taste (install Flask and gunicorn first):
```python3
from uapi.flask import App
app = App()
@app.get("/")
def index() -> str:
return "Index"
app.serve_openapi()
app.serve_elements()
app.run(__name__) # Now open http://localhost:8000/elements
```
## Project Information
- [**PyPI**](https://pypi.org/project/uapi/)
- [**Source Code**](https://github.com/Tinche/uapi)
- [**Documentation**](https://uapi.threeofwands.com)
- [**Changelog**](https://uapi.threeofwands.com/en/latest/changelog.html)
## License
_uapi_ is written by [Tin Tvrtković](https://threeofwands.com/) and distributed under the terms of the [Apache-2.0](https://spdx.org/licenses/Apache-2.0.html) license.