"description": "Fetches historical FX rates from fixer. We are using Django and we noticed that (in > 'Generate Server') Django is not an option, unfortunately. "description": "ISO symbol of base currency", "description": "FX date in yyyy-mm-dd format", "description": "Fetches historical FX rates from fixer.io", The content is stored with a key ‘swagger-editor-content’. The Swagger Editor uses the browser local storage to store the editor content. The only problem is that I am limited to currencies I define in the swagger, and input/hints as to how to make this work with any list of currencies would be welcome. What I’m going to show you is how to get the modified content from the editor and do some thing useful with it. URL to swagger.io's online schema validator.I have found the below solution (and I show the full swagger if anyone needs to fetch European Central Bank exchange rates). Set to True to display the request headers.Ī list of HTTP methods can be interacted with using the "Try it out!" button.ĭefault: VALIDATOR_URL It can be set to:Įnables a graphical view for editing complex bodies. Set to alpha to enable alphabetical sorting.Ĭontrols how the API listing is displayed. Note that for more advanced use cases, you may wish to write your own rest_framework_swagger/static/init.js file. CUSTOM_HEADERSĭefine a dictionary of values to be passed as HTTP headers in all API requests.Īll key/val provided in this dictionary will be set on the request headers forīelow are some basic configuration settings for SwaggerUI. Use this setting if you are using the AcceptHeaderVersioning version schemeĪnd require a value to interact with the API.Į.g.: Setting to 1.0 will modify the HTTP Accept header fromĪpplication/json to application/json version=1.0.įor further customization, use the CUSTOM_HEADERS. The schemes types currently supported by the OpenAPI 2.0 spec are basic, apiKey and oauth2.įor more information on available options, please consult the OpenAPI Security Object Definition. The security definitions configures which authentication methods can be used by Swagger. Accepts named URL patterns.ĭefault: _URL SECURITY_DEFINITIONS The URL to use to log out of session authentication. Accepts named URL patterns.ĭefault: _URL LOGOUT_URL We will follow the following steps to build a Swagger UI document for an API function: First, we will create the API using Flask web API framework. The URL to use to log in session authentication. Settings.py LOGIN_URL = 'rest_framework:login' Url(r'^api-auth/', include('rest_framework.urls', namespace='rest_framework')) These can either be configured under SWAGGER_SETTINGS or Django settings.
Note: The login/logout button relies on the LOGIN_URL and LOGOUT_URL settings which default to /accounts/login. Setting it to True will displayĪ login/logout button on the Swagger UI and post csrf_tokens to the API.
Toggles the use of Django Auth as an authentication mechanism.
Settings are configurable in settings.py by defining SWAGGER_SETTINGS. The configuration of Django REST Swagger is identical to Django REST Framework.
0 kommentar(er)
