{"id":14065491,"url":"https://github.com/sveint/flask-swagger-ui","last_synced_at":"2025-05-16T18:10:28.582Z","repository":{"id":11582907,"uuid":"70066421","full_name":"sveint/flask-swagger-ui","owner":"sveint","description":"Swagger UI blueprint for flask","archived":false,"fork":false,"pushed_at":"2025-05-13T09:02:48.000Z","size":12296,"stargazers_count":183,"open_issues_count":28,"forks_count":62,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-05-13T09:42:09.416Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sveint.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-10-05T14:07:19.000Z","updated_at":"2025-03-20T15:23:25.000Z","dependencies_parsed_at":"2024-05-28T01:50:31.310Z","dependency_job_id":null,"html_url":"https://github.com/sveint/flask-swagger-ui","commit_stats":{"total_commits":39,"total_committers":8,"mean_commits":4.875,"dds":0.2564102564102564,"last_synced_commit":"93268ed950956e3858f4bf2befbbb23c7c9b8e30"},"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sveint%2Fflask-swagger-ui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sveint%2Fflask-swagger-ui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sveint%2Fflask-swagger-ui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sveint%2Fflask-swagger-ui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sveint","download_url":"https://codeload.github.com/sveint/flask-swagger-ui/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254582907,"owners_count":22095518,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-13T07:04:31.289Z","updated_at":"2025-05-16T18:10:28.576Z","avatar_url":"https://github.com/sveint.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"# flask-swagger-ui\n\nSimple Flask blueprint for adding [Swagger UI](https://github.com/swagger-api/swagger-ui) to your flask application.\n\nIncluded Swagger UI version: 5.21.0.\n\n**This project is not actively maintained, but might receive occasional updates. Please fork it if you need a newer version.**\n\n## Installation\n\n`pip install flask-swagger-ui`\n\n## Usage\n\nExample application:\n\n```python\nfrom flask import Flask\nfrom flask_swagger_ui import get_swaggerui_blueprint\n\napp = Flask(__name__)\n\n\nSWAGGER_URL = '/api/docs'  # URL for exposing Swagger UI (without trailing '/')\nAPI_URL = 'https://petstore.swagger.io/v2/swagger.json'  # Our API url (can of course be a local resource)\n\n# Call factory function to create our blueprint\nswaggerui_blueprint = get_swaggerui_blueprint(\n    SWAGGER_URL,  # Swagger UI static files will be mapped to '{SWAGGER_URL}/dist/'\n    API_URL,\n    config={  # Swagger UI config overrides\n        'app_name': \"Test application\"\n    },\n    # oauth_config={  # OAuth config. See https://github.com/swagger-api/swagger-ui#oauth2-configuration .\n    #    'clientId': \"your-client-id\",\n    #    'clientSecret': \"your-client-secret-if-required\",\n    #    'realm': \"your-realms\",\n    #    'appName': \"your-app-name\",\n    #    'scopeSeparator': \" \",\n    #    'additionalQueryStringParams': {'test': \"hello\"}\n    # }\n)\n\napp.register_blueprint(swaggerui_blueprint)\n\napp.run()\n\n# Now point your browser to localhost:5000/api/docs/\n\n```\n\n## Configuration\n\nThe blueprint supports overloading all Swagger UI configuration options that can be JSON serialized.\nSee https://github.com/swagger-api/swagger-ui/blob/master/docs/usage/configuration.md#parameters for options.\n\nPlugins and function parameters are not supported at this time.\n\nOAuth2 parameters can be found at https://github.com/swagger-api/swagger-ui#oauth2-configuration .\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsveint%2Fflask-swagger-ui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsveint%2Fflask-swagger-ui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsveint%2Fflask-swagger-ui/lists"}