{"id":13936737,"url":"https://github.com/sphinx-contrib/openapi","last_synced_at":"2025-05-15T07:07:19.640Z","repository":{"id":47335057,"uuid":"68995825","full_name":"sphinx-contrib/openapi","owner":"sphinx-contrib","description":"OpenAPI (fka Swagger) spec renderer for Sphinx.","archived":false,"fork":false,"pushed_at":"2025-01-10T00:08:22.000Z","size":359,"stargazers_count":118,"open_issues_count":48,"forks_count":87,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-05-09T07:06:29.632Z","etag":null,"topics":["extension","hacktoberfest","oas","openapi","openapi2","openapi3","python","sphinx","sphinx-extension","swagger"],"latest_commit_sha":null,"homepage":"https://sphinxcontrib-openapi.readthedocs.io","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sphinx-contrib.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGES","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-09-23T06:28:32.000Z","updated_at":"2025-03-23T05:11:18.000Z","dependencies_parsed_at":"2025-02-05T18:00:40.598Z","dependency_job_id":"f25875d8-fcb1-4f36-b95d-81d363cdb3db","html_url":"https://github.com/sphinx-contrib/openapi","commit_stats":{"total_commits":147,"total_committers":17,"mean_commits":8.647058823529411,"dds":0.6258503401360545,"last_synced_commit":"ee9e232e19be1e01cc682926e77790a0df300108"},"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-contrib%2Fopenapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-contrib%2Fopenapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-contrib%2Fopenapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-contrib%2Fopenapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sphinx-contrib","download_url":"https://codeload.github.com/sphinx-contrib/openapi/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254292042,"owners_count":22046426,"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":["extension","hacktoberfest","oas","openapi","openapi2","openapi3","python","sphinx","sphinx-extension","swagger"],"created_at":"2024-08-07T23:02:57.124Z","updated_at":"2025-05-15T07:07:14.625Z","avatar_url":"https://github.com/sphinx-contrib.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"=====================\nsphinxcontrib-openapi\n=====================\n\n**sphinxcontrib-openapi** is a `Sphinx`_ extension to generate APIs docs from\n`OpenAPI`_ (fka Swagger) spec. It depends on `sphinxcontrib-httpdomain`_ that\nprovides an HTTP domain for describing RESTful HTTP APIs, so we don't need to\nreinvent the wheel.\n\n.. code:: bash\n\n   $ python3 -m pip install sphinxcontrib-openapi\n\n\nUsage\n=====\n\nPass ``sphinxcontrib-openapi`` to ``extensions`` list in  Sphinx's ``conf.py``\n\n.. code:: python\n\n   extensions = [\n      ...\n      'sphinxcontrib.openapi',\n   ]\n\nand feel free to use the ``openapi`` directive to render OpenAPI specs\n\n.. code:: restructuredtext\n\n   .. openapi:: path/to/openapi.yml\n\n\nLinks\n=====\n\n* Documentation: https://sphinxcontrib-openapi.readthedocs.org/\n* Source: https://github.com/sphinx-contrib/openapi\n* Bugs: https://github.com/sphinx-contrib/openapi/issues\n\n\n.. _Sphinx: https://www.sphinx-doc.org/en/master/\n.. _OpenAPI: https://github.com/OAI/OpenAPI-Specification\n.. _sphinxcontrib-httpdomain: https://sphinxcontrib-httpdomain.readthedocs.io/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsphinx-contrib%2Fopenapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsphinx-contrib%2Fopenapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsphinx-contrib%2Fopenapi/lists"}