Flasgger Versions Save

Easy OpenAPI specs and Swagger UI for your Flask API

0.8.2

5 years ago
  • Update index.html
  • Update index.html
  • Merge pull request #180 from anilpai/anilpai-patch-1
  • Update jwt_auth.py
  • Merge pull request #182 from anilpai/patch-1
  • Avoid inclusion of empty definition dict
  • Merge pull request #184 from mmichaels01/master
  • Fix README.md error
  • Merge pull request #186 from phylee/master
  • Fix get_schema exception message
  • Merge pull request #187 from boris-42/fix_get_schema_exc_message
  • Fix erroneous extra definitions objects
  • adding support for requestBody
  • fixing python 2.7 incompliant syntax
  • Merge pull request #191 from zrayn/add-requestBody-support
  • Merge pull request #190 from abstiles/fix-extra-definitions
  • Validate examples according to Swagger spec
  • Correct example's declaration as OpenAPI 3.0
  • Correct reference of invalid type int32
  • Make example python filter more strict
  • Fall back to simpler validation for OpenAPI 3
  • Skip validation of intentionally invalid example
  • Merge pull request #193 from abstiles/enhance-tests

0.8.3

5 years ago
  • Small update to release target (using twine)

0.9.0

5 years ago

See examples/changelog_090.py

  • Updated Swagger UI 3.x
  • uiversion now defaults to 3
  • 'hide_top_bar' config option to remove the green top bar
  • 'fotter_text' added to customize the footer text (allows html and <script>)
  • templates/flasgger/footer.html added and can be replaced to customization this footer.html is the right place for custom <script>
  • 'top_text' added to customize the header text (allows html)
  • templates/flasgger/top.html added and can be replaced to customization
  • 'head_text' added to customize the (allows html)
  • templates/flasgger/head.html added and can be replaced to customization
  • added 'doc_expansion' config to control the collapse
  • added 'ui_params' to allow override of any swagger.ui values
  • break index templates into individual customizable templates
  • schemes pulled from config if present

0.8.1

6 years ago
  • Add Flask-JWT support
  • Load YAML from external files with no summary/description. Fixes #93

0.8.0

6 years ago

Reverted the automatic set of json_encoder and allowed user to import LAzyJSONEncoder (tks @SBillion)

0.7.0

6 years ago

0.6.6

6 years ago
  • Support custom validation functions
  • Swagger::get_schema method to get defined schemas as python dicts
  • Updated static UI versions from latest github distribution
  • Better test for import functionality

0.6.5

6 years ago
  • Suporting for decorating FlasggerViews (to protect with login etc)
  • description and summary are now optional
  • specs_route fix to be customized /specs_route to /anything
  • enable/disable swagger UI (if you only need specs json)
  • attempt to fix #102 allowing import: from subfolders

0.6.4

6 years ago

added support for template file argument.

having this yaml

definitions:
  Data:
    type: object
    properties:
      _id:
        type: string

paths:
  /cv:
    put:
      parameters:
        - name: body
          in: body
          required: true
          schema:
            $ref: '#/definitions/Data'
      responses:
        200:
          description: |
            Please wait the calculation, you'll receive an email with results
    delete:
      parameters:
        - name: body
          in: body
          required: true
          schema:
            $ref: '#/definitions/Data'
      responses:
        200:
          description: |
            Please wait the calculation, you'll receive an email with results
    post:
      responses:
        200:
          description: done

You can now load in

from flask import Flask
from flasgger import Swagger


app = Flask(__name__)
Swagger(app, template_file='test.yaml')


@app.route('/cv', methods=['POST', 'PUT', 'DELETE'])
def cv():
    """
    Micro Service Based API for CV operations
    This API is for job to CVs matching operations
    """


app.run(debug=True)

and get

fqjskcb

0.6.3

7 years ago

0.6.3

  • HOTFIX: Support views using decorator package (#80)

0.6.2

  • introduced tests on Travis CI (examples apps as test cases)
  • Fix blueprint support (examples/blueprint_example.py)
  • Added prefix_ids = True for compat with <= 05.14 (see examples/compat.py)
  • Added import: another.yml to inherit YAML files.
  • Fix missing lib static folder
  • Added support for Flask RESTful (examples/restful.py)
  • Added APISpec support (examples/apispec.py)
  • Fix error in case of empty MethodViews

0.6.1

  • HOTFIX: added six (missing requirement)

0.6.0

  • Fixed support for MethodViews
  • Added swag.definition to class based definitions
  • Added support for docs in dispatch_request (for FlaskRESTful compat)
  • Upgrades Swagger UI
  • Added uiversion = 3 to support new experimental swagger UI
  • Improved validate to abort with error so no need for try: validate...
  • validate does not require root argument
  • Definitions is no more prefixed with fucntion and http method names
  • Dictionary can be used as specs in @swag_from