https://github.com/notjustatoy/falcon-heavy

The framework for building app backends and microservices by specification-first API design approach based on the OpenAPI Specification 3
https://github.com/notjustatoy/falcon-heavy

django falcon-framework flask oas3 openapi3 python3 specification-first swagger

Last synced: 2 months ago
JSON representation

The framework for building app backends and microservices by specification-first API design approach based on the OpenAPI Specification 3

• Host: GitHub
• URL: https://github.com/notjustatoy/falcon-heavy
• Owner: NotJustAToy
• License: apache-2.0
• Created: 2019-12-05T08:57:06.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2020-03-02T08:06:55.000Z (almost 5 years ago)
• Last Synced: 2024-10-13T23:42:57.114Z (2 months ago)
• Topics: django, falcon-framework, flask, oas3, openapi3, python3, specification-first, swagger
• Language: Python
• Homepage:
• Size: 186 KB
• Stars: 23
• Watchers: 3
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
************

Falcon Heavy

************

About

#####

The framework for building app backends and microservices by specification-first API design approach based on the `OpenAPI Specification 3 `__.

Falcon Heavy converts and validates requests and renders responses corresponded specification. It can be used with `Django `__, `Falcon `__ and `Flask `__ web frameworks.

Installation

############

Recommended way (via pip):

.. code:: bash

    $ pip install falcon-heavy

Usage

#####

1. Implement all abstract methods from a corresponding decorator class.

2. Set up routing based on a specification.

3. Decorate views with your decorator.

Limitations

###########

* XML is not supported.

* Can't use reserved characters in path and query parameters.

* Recursive dependencies detection not implemented.

License

#######

Copyright 2019-2020 Not Just A Toy Corp.

Licensed under the Apache License, Version 2.0 (the "License");

you may not use this file except in compliance with the License.

You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software

distributed under the License is distributed on an "AS IS" BASIS,

WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

See the License for the specific language governing permissions and

limitations under the License.