Falsy

FAL.S.Y

Описание

Это фреймворк для API. Использует Falcon, Swagger и YAML вместе!

Лицензия

MIT и Apache v2.

Showtime

Как установить

pip install falsy.

Как использовать

0. Создайте каталог для статических файлов:

   mkdir static.

1. Напишите код сервера (main.py):

    ```python
    from falsy.falsy import FALSY
   
    f = FALSY()  # Перед запуском необходимо создать каталог с именем static.
    f.swagger('test.yml', ui=True, theme='impress')  # impress — это адаптивный пользовательский интерфейс Swagger, или вы можете использовать здесь 'normal'.
    api = f.api
    ```

2. Напишите файл YAML:

    ```yaml
    swagger: '2.0'
    info:
    title: FALSY SIMPLE DEMO API
    version: "0.1"
    consumes:
    - application/json
    produces:
    - application/json
    basePath: "/v1"
    paths:
      '/hello':
        get:
          tags: [Method]
          operationId: demo.get_it
          summary: testing
          parameters:
            - name: name
              in: query
              type: string
              default: 'john'
          responses:
            200:
              description: Return response
    ```

3. Напишите обработчик операций (demo.py):

    ```python
    def get_it(name):
        return {
            'get': name
        }
    ```

4. Запустите его:

    `gunicorn -b 0.0.0.0:8001 main:api --reload -w 1 --threads 1`.

5. Посетите страницу пользовательского интерфейса:

    `http://0.0.0.0:8001/v1/ui/`
    Убедитесь, что она заканчивается на '/'.

Видеодемонстрация

.

Расширения

Есть некоторые улучшения по сравнению со стандартным Swagger. Можно определить operationId для обработчика, beforeId и afterId для АОП-хуков, а также validationId для валидатора. Подробности см. в файлах в демонстрационном каталоге.