flaskerk 0.2.0

No project description provided

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

install with pip install flaskerk (Python 3.6+)

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 here
    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' or curl -X POST -H "Content-Type: application/json" -d '{"name"="hello", "uid"="uuuuu"}' http://127.0.0.1:5000/api/recommend

Open the docs in http://127.0.0.1:5000/docs .

For more examples, check examples.