Individual operations can override this definition. Only one of the security requirement objects need to be satisfied to authorize a request. The list of values includes alternative security requirement objects that can be used. | ``security`` | A declaration of which security mechanisms can be used across the API. Maps to the ``responses`` field of the `operation object `_. | ``responses`` | The responses that can be used across operations. Maps to the ``parameters`` field of the `operation object `_. | ``parameters`` | The parameters that can be used across operations. Maps to the ``license`` field of the `info object `_. | ``license`` | The license information for the API. Maps to the ``externalDocs`` field of the `operation object `_. | ``external_docs`` | Additional external documentation. Maps to the ``description`` field of the `info object `_. | ``description`` | A short description of the application. Maps to the ``contact`` field of the `info object `_. | ``contact`` | The contact information for the API. All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object. | ``components`` | A list reusable objects for different aspects of the OAS. | ``servers`` | The server on which the API is served, it replaces ``schemes``, ``host`` and ``base_path``. | ``swagger_url`` | The URL path that serves the swagger specification document (defaults to ``swagger.json``). | ``swagger_prefix_url`` | The URL prefix for swagger (defaults to ``/api/doc)`` | Maps to the ``version`` field of the `info object `_. | ``version`` | The API version string (defaults to '0.0'). | ``add_api_spec_resource`` | Set to ``True`` to add an endpoint to serve the swagger specification (defaults to ``True``). The Api class supports the following parameters: # It supports several (optional) parameters, these are the defaults: # Use the swagger Api class as you would use the flask restful class. # Instead of using this: from flask_restful import Api ``from flask_restful_swagger_3 import Api``. To use it, change your import from ``from flask_restful import Api`` to Which enables `swagger3 `_ support according to the
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |