{"id":14065304,"url":"https://github.com/marshmallow-code/apispec-webframeworks","last_synced_at":"2025-05-16T19:07:27.285Z","repository":{"id":33183294,"uuid":"151890275","full_name":"marshmallow-code/apispec-webframeworks","owner":"marshmallow-code","description":"Web framework plugins for apispec (formally in apispec.ext).","archived":false,"fork":false,"pushed_at":"2025-05-06T19:51:10.000Z","size":161,"stargazers_count":33,"open_issues_count":9,"forks_count":23,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-05-16T19:06:48.643Z","etag":null,"topics":["apispec","bottle","flask","openapi","python","tornado"],"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/marshmallow-code.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.rst","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":"AUTHORS.rst","dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2018-10-06T23:31:31.000Z","updated_at":"2025-05-06T19:51:12.000Z","dependencies_parsed_at":"2023-09-29T23:57:37.857Z","dependency_job_id":"aef94c3c-2751-40ae-8ac0-7f1b3b64901a","html_url":"https://github.com/marshmallow-code/apispec-webframeworks","commit_stats":{"total_commits":197,"total_committers":14,"mean_commits":"14.071428571428571","dds":0.6446700507614214,"last_synced_commit":"0b4b79c13507ddb85d1f044e6e316ffaffe46981"},"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marshmallow-code%2Fapispec-webframeworks","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marshmallow-code%2Fapispec-webframeworks/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marshmallow-code%2Fapispec-webframeworks/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marshmallow-code%2Fapispec-webframeworks/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/marshmallow-code","download_url":"https://codeload.github.com/marshmallow-code/apispec-webframeworks/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254592395,"owners_count":22097013,"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":["apispec","bottle","flask","openapi","python","tornado"],"created_at":"2024-08-13T07:04:25.405Z","updated_at":"2025-05-16T19:07:27.259Z","avatar_url":"https://github.com/marshmallow-code.png","language":"Python","readme":"*********************\napispec-webframeworks\n*********************\n\n|pypi| |build-status| |marshmallow3|\n\n.. |pypi| image:: https://badgen.net/pypi/v/apispec-webframeworks\n    :target: https://pypi.org/project/apispec-webframeworks/\n    :alt: PyPI package\n\n.. |build-status| image:: https://github.com/marshmallow-code/apispec-webframeworks/actions/workflows/build-release.yml/badge.svg\n    :target: https://github.com/marshmallow-code/apispec-webframeworks/actions/workflows/build-release.yml\n    :alt: Build status\n\n.. |marshmallow3| image:: https://badgen.net/badge/marshmallow/3?\n    :target: https://marshmallow.readthedocs.io/en/latest/upgrading.html\n    :alt: marshmallow 3 compatible\n\n`apispec \u003chttps://github.com/marshmallow-code/apispec\u003e`_ plugins for\nintegrating with various web frameworks.\n\nThese plugins used to be in ``apispec.ext`` but have since\nbeen moved to their own package.\n\n\nIncluded plugins:\n\n* ``apispec_webframeworks.aiohttp``\n* ``apispec_webframeworks.bottle``\n* ``apispec_webframeworks.flask``\n* ``apispec_webframeworks.tornado``\n\nMigration from ``apispec\u003c1.0.0``\n================================\n\nTo migrate from older versions of apispec, install this package\nwith\n\n.. code-block:: console\n\n    pip install apispec-webframeworks\n\n\nChange your imports, like so:\n\n.. code-block:: python\n\n    # apispec\u003c1.0.0\n    from apispec.ext.flask import FlaskPlugin\n\n    # apispec\u003e=1.0.0\n    from apispec_webframeworks.flask import FlaskPlugin\n\nExample Usage\n=============\n\n.. code-block:: python\n\n    from flask import Flask\n    from apispec import APISpec\n    from apispec.ext.marshmallow import MarshmallowPlugin\n    from apispec_webframeworks.flask import FlaskPlugin\n    from marshmallow import Schema, fields\n\n    spec = APISpec(\n        title=\"Gisty\",\n        version=\"1.0.0\",\n        info=dict(description=\"A minimal gist API\"),\n        plugins=[FlaskPlugin(), MarshmallowPlugin()],\n    )\n\n\n    app = Flask(__name__)\n\n\n    class GistParameter(Schema):\n        gist_id = fields.Int()\n\n\n    class GistSchema(Schema):\n        id = fields.Int()\n        content = fields.Str()\n\n\n    @app.route(\"/gists/\u003cgist_id\u003e\")\n    def gist_detail(gist_id):\n        \"\"\"Gist detail view.\n        ---\n        get:\n            parameters:\n                    - in: path\n                    schema: GistParameter\n            responses:\n                    200:\n                    schema: GistSchema\n        \"\"\"\n        return \"details about gist {}\".format(gist_id)\n\n\n    # Since `path` inspects the view and its route,\n    # we need to be in a Flask request context\n    with app.test_request_context():\n        spec.path(view=gist_detail)\n\nDocumentation\n=============\n\nFor documentation for a specific plugin, see its module docstring.\n\n\nDevelopment\n===========\n\n* Clone and cd into this repo\n* Create and activate a virtual environment\n* Install this package (in editable mode) and the development\n  dependencies\n\n::\n\n    $ pip install '.[dev]'\n\n* Install pre-commit hooks\n\n::\n\n    $ pre-commit install\n\n\nRunning tests\n-------------\n\nTo run all tests: ::\n\n    $ pytest\n\nTo run syntax checks: ::\n\n    $ tox -e lint\n\n(Optional) To run tests in all supported Python versions in their own virtual environments (must have each interpreter installed): ::\n\n    $ tox\n\nLicense\n=======\n\nMIT licensed. See the bundled `LICENSE \u003chttps://github.com/marshmallow-code/apispec_webframeworks/blob/master/LICENSE\u003e`_ file for more details.\n","funding_links":[],"categories":["Python"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarshmallow-code%2Fapispec-webframeworks","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmarshmallow-code%2Fapispec-webframeworks","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarshmallow-code%2Fapispec-webframeworks/lists"}