A simple async API framework based on Starlette.
Star OpenAPI is a web API framework based on Starlette. It uses Pydantic to verify data and automatic generation of interaction documentation.
The key features are:
-
Easy to code: Easy to use and easy to learn
-
Standard document specification: Based on OpenAPI Specification
-
Interactive OpenAPI documentation: Swagger, Redoc, RapiDoc, RapiPdf, Scalar, Elements
-
Data validation: Fast data verification based on Pydantic
-
Websocket: Support for websocket
Requirements
Python 3.11+
star-openapi is dependent on the following libraries:
Installation
pip install -U star-openapi[swagger]
Optional dependencies
httpx- Required if you want to use theTestClient.python-multipart- Required if you want to support form parsing, withrequest.form().itsdangerous- Required forSessionMiddlewaresupport.pyyaml- Required forSchemaGeneratorsupport.
You can install all of these with pip install star-openapi[full].
- star-openapi-plugins Provide OpenAPI UI for star-openapi.
You can install all of these with pip install star-openapi[swagger,redoc,rapidoc,rapipdf,scalar,elements].
A Simple Example
Here's a simple example, further go to the Example.
import uvicorn
from pydantic import BaseModel
from starlette.responses import JSONResponse
from star_openapi import OpenAPI
info = {"title": "Star API", "version": "1.0.0"}
app = OpenAPI(info=info)
book_tag = {"name": "book", "description": "book tag"}
class BookModel(BaseModel):
name: str
age: int
@app.post("/book", summary="get books", tags=[book_tag])
async def create_user(body: BookModel):
"""
get all books
"""
print(body.model_dump_json())
return JSONResponse({"message": "Hello World"})
if __name__ == "__main__":
print(app.routes)
uvicorn.run(app)
API Document
Run the simple example, and go to http://127.0.0.1:8000/openapi.
OpenAPI UI plugins are optional dependencies that require manual installation.
pip install -U star-openapi[swagger,redoc,rapidoc,rapipdf,scalar,elements]More optional ui templates goto the document about UI_Templates.
Metadata
Release files for star-openapi 0.9.8
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| star_openapi-0.9.8.tar.gz | 564.4 kB | Without provenance | Details for star_openapi-0.9.8.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| star_openapi-0.9.8-py3-none-any.whl | Python 3 | none | any | Details for star_openapi-0.9.8-py3-none-any.whl |
Total release size: 606.3 kB
Release files / star_openapi-0.9.8.tar.gz
| Download URL | star_openapi-0.9.8.tar.gz |
|---|---|
| Size | 564.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7153d6958488c78b19dd9fc95470a4fa105ce8c5cfc4d8af88a6767c990a911e
|
|
BLAKE2b-256 checksum How to use checksums |
9046aff77bf07a8612c7ed1a5ea61c277350bac61cf639e5a33d6f18edd4b8fe
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.13.0 {"installer":{"name":"uv","version":"0.13.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / star_openapi-0.9.8-py3-none-any.whl
| Download URL | star_openapi-0.9.8-py3-none-any.whl |
|---|---|
| Size | 41.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2331f7c0a9c3b03848b6dcb0bf6f4175806d8195f16384b5519786287d106a51
|
|
BLAKE2b-256 checksum How to use checksums |
1396205b3e6efbb4e973f384ddaa05120a16bdc4e5ce48bd7b7861c0debba205
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.13.0 {"installer":{"name":"uv","version":"0.13.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Security for star-openapi 0.9.8
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.