{"id":20037807,"url":"https://github.com/openedx/api-doc-tools","last_synced_at":"2025-04-07T17:08:46.419Z","repository":{"id":37822959,"uuid":"218371970","full_name":"openedx/api-doc-tools","owner":"openedx","description":"Tools for writing and generating API documentation for edX REST APIs","archived":false,"fork":false,"pushed_at":"2025-03-27T04:23:54.000Z","size":434,"stargazers_count":7,"open_issues_count":19,"forks_count":11,"subscribers_count":52,"default_branch":"master","last_synced_at":"2025-03-31T14:14:30.261Z","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":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/openedx.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.rst","contributing":null,"funding":null,"license":"LICENSE.txt","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":"2019-10-29T19:55:09.000Z","updated_at":"2025-02-12T12:35:15.000Z","dependencies_parsed_at":"2022-08-19T17:20:52.289Z","dependency_job_id":"0dfba576-6259-48aa-91b4-42fbe9016fd3","html_url":"https://github.com/openedx/api-doc-tools","commit_stats":{"total_commits":154,"total_committers":26,"mean_commits":5.923076923076923,"dds":0.6363636363636364,"last_synced_commit":"e173a92473dd3228eee9ed091d4c1ef3895605df"},"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openedx%2Fapi-doc-tools","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openedx%2Fapi-doc-tools/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openedx%2Fapi-doc-tools/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openedx%2Fapi-doc-tools/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openedx","download_url":"https://codeload.github.com/openedx/api-doc-tools/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247694876,"owners_count":20980733,"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-11-13T10:22:36.785Z","updated_at":"2025-04-07T17:08:46.399Z","avatar_url":"https://github.com/openedx.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"edX API Documentation Tools\n===========================\n\n|pypi| |CI| |codecov| |readthedocs| |pyversions| |license|\n\nA toolkit for documenting REST APIs that are created with `DRF`_.\n\n.. _DRF: https://www.django-rest-framework.org/\n\nThe tools use `drf-yasg`_ (DRF, yet another Swagger generator) to generate an\n`OpenAPI Specification`_, which is a .json/.yaml file that describes your API.\nAdditionally, this package makes it easy to configure your service to expose\ngenerated OpenAPI specification under `/api-docs.yaml` and to serve interactive\ndocumentation under `/api-docs`.\n\n.. _drf-yasg: https://github.com/axnsan12/drf-yasg\n.. _OpenAPI Specification: https://swagger.io/docs/specification/about/\n\nThis library was developed for use with `Open edX`_ services, but could be used\nto document any Django REST Framework API.\n\n.. _Open edX: https://open.edx.org/\n\n\nQuick Start\n-----------\n\nTo start using this tool in your project, see\n`Adding edx-api-doc-tools to your project \u003cdocs/adding.rst\u003e`_.\n\nTo write docs using this tool, see\n`Writing API documentation \u003cdocs/writing.rst\u003e`_.\n\n\nDocumentation\n-------------\n\nComphrehensive documentation is coming soon.  For now, check out the `example/`\ndirectory, which shows a fake API using these tools to generate documentation.\n\nLicense\n-------\n\nThe code in this repository is licensed under the Apache Software License 2.0\nunless otherwise noted.\n\nPlease see `LICENSE.txt \u003cLICENSE.txt\u003e`_ for details.\n\nHow To Contribute\n-----------------\n\nContributions are very welcome.  Please read `How To Contribute`__ for details.\nEven though they were written with `edx-platform` in mind, the guidelines\nshould be followed for all Open edX projects.\n\n__ https://github.com/openedx/.github/blob/master/CONTRIBUTING.md\n\nThe pull request description template should be automatically applied if you\nare creating a pull request from GitHub. Otherwise you can find it at\n`PULL_REQUEST_TEMPLATE.md`_.\n\nThe issue report template should be automatically applied if you are creating\nan issue on GitHub as well. Otherwise you can find it at `ISSUE_TEMPLATE.md`_.\n\n.. _PULL_REQUEST_TEMPLATE.md: .github/PULL_REQUEST_TEMPLATE.md\n.. _ISSUE_TEMPLATE.md: .github/ISSUE_TEMPLATE.md\n\nReporting Security Issues\n-------------------------\n\nPlease do not report security issues in public. Please email security@openedx.org.\n\nGetting Help\n------------\n\nHave a question about this repository, or about the Open edX project in general?  Please refer to this `list of resources \u003chttps://open.edx.org/getting-help\u003e`_ if you need any assistance.\n\n\n\n.. |pypi| image:: https://img.shields.io/pypi/v/edx-api-doc-tools.svg\n    :target: https://pypi.python.org/pypi/edx-api-doc-tools/\n    :alt: PyPI\n.. |CI| image:: https://github.com/openedx/api-doc-tools/workflows/Python%20CI/badge.svg?branch=master\n    :target: https://github.com/openedx/api-doc-tools/actions?query=workflow%3A%22Python+CI%22\n    :alt: CI\n.. |codecov| image:: http://codecov.io/github/edx/api-doc-tools/coverage.svg?branch=master\n    :target: http://codecov.io/github/edx/api-doc-tools?branch=master\n    :alt: Codecov\n.. |readthedocs| image:: https://readthedocs.org/projects/edx-api-doc-tools/badge/?version=latest\n    :target: http://edx-api-doc-tools.readthedocs.io/en/latest/\n    :alt: Documentation\n.. |pyversions| image:: https://img.shields.io/pypi/pyversions/edx-api-doc-tools.svg\n    :target: https://pypi.python.org/pypi/edx-api-doc-tools/\n    :alt: Supported\n.. |license| image:: https://img.shields.io/github/license/edx/api-doc-tools.svg\n    :target: https://github.com/openedx/api-doc-tools/blob/master/LICENSE.txt\n    :alt: License\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenedx%2Fapi-doc-tools","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenedx%2Fapi-doc-tools","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenedx%2Fapi-doc-tools/lists"}