No project description provided
Project description
Flaskerk
Provide OpenAPI document and validation for flask service.
Mainly built for Machine Learning Model services.
Features
- JSON data(request&response) validation with pydantic
- Redoc UI
- OpenAPI spec
- Swagger UI
- support flask url path validation
Quick Start
from typing import List
from flask import Flask, request
from flaskerk import Flaskerk
from pydantic import BaseModel
class Query(BaseModel):
name: str
uid: str
limit: int = 5
class Response(BaseModel):
users: List[str]
app = Flask(__name__)
api = Flaskerk(app)
@app.route('/api/recommend', methods=['POST'])
@api.validate(query=Query, resp=Response)
def recommend():
# algorithm
user = request.query
print(user.name, user.uid)
return Response(users=['xxx'] * user.limit)
if __name__ == '__main__':
app.run()
try it with http POST :5000/api/recommend name='hello' uid='uuuuu'
For more examples, check examples.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
flaskerk-0.1.0.tar.gz
(3.8 kB
view hashes)