Metadata-Version: 2.1
Name: flask-schematics-swagger
Version: 0.0.3
Summary: Flask Swagger generator for Schematics models.
Home-page: https://github.com/trk54ylmz/flask-schematics-swagger
Author: Tarik Yilmaz
Author-email: tarikyilmaz.54@gmail.com
Classifier: Development Status :: 3 - Alpha
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >=3.7
Description-Content-Type: text/markdown

### Flask Schematics Swagger

[![PR](https://github.com/trK54Ylmz/flask-schematics-swagger/actions/workflows/pr.yaml/badge.svg)](https://github.com/trK54Ylmz/flask-schematics-swagger/actions/workflows/pr.yaml)
[![PyPI version](https://badge.fury.io/py/flask-schematics-swagger.svg)](https://badge.fury.io/py/flask-schematics-swagger)

Flask Swagger generator for Schematics models.

#### Install

Install library by using `pip` command,

```bash
$ pip3 install flask-schematics-swagger
```

#### Usage

```python
from flask import Flask, request
from fss import FlaskSchematicsSwagger

app = Flask('app')
fss = FlaskSchematicsSwagger(app)


@app.get('/users')
def get_users() -> dict:
    """
    Get list of users

    :parameter query integer user_id: the user id filter. default: None
    :response 200 schema.user.UserGetResponse:
    :return: flask response as dictionary
    """
    user_id = request.args.get('user_id')

    # ...

    return response.to_primitive()


if __name__ == '__main__':
    fss.add_route()
    app.run()
```
