{"id":37083009,"url":"https://github.com/yishenggudou/sphinx-rest-api-doc","last_synced_at":"2026-01-14T10:02:27.406Z","repository":{"id":57469949,"uuid":"152272231","full_name":"yishenggudou/sphinx-rest-api-doc","owner":"yishenggudou","description":"rest api example","archived":false,"fork":false,"pushed_at":"2018-11-18T15:42:47.000Z","size":45,"stargazers_count":0,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-09-18T01:37:14.890Z","etag":null,"topics":["docs","python","python36","sphinx","sphinx-extension"],"latest_commit_sha":null,"homepage":null,"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/yishenggudou.png","metadata":{"files":{"readme":"README.rst","changelog":"ChangeLog","contributing":"CONTRIBUTING.rst","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-10-09T15:07:25.000Z","updated_at":"2018-11-18T15:42:48.000Z","dependencies_parsed_at":"2022-09-19T10:20:58.101Z","dependency_job_id":null,"html_url":"https://github.com/yishenggudou/sphinx-rest-api-doc","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/yishenggudou/sphinx-rest-api-doc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yishenggudou%2Fsphinx-rest-api-doc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yishenggudou%2Fsphinx-rest-api-doc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yishenggudou%2Fsphinx-rest-api-doc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yishenggudou%2Fsphinx-rest-api-doc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yishenggudou","download_url":"https://codeload.github.com/yishenggudou/sphinx-rest-api-doc/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yishenggudou%2Fsphinx-rest-api-doc/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28416497,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-14T08:38:59.149Z","status":"ssl_error","status_checked_at":"2026-01-14T08:38:43.588Z","response_time":107,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["docs","python","python36","sphinx","sphinx-extension"],"created_at":"2026-01-14T10:02:26.421Z","updated_at":"2026-01-14T10:02:27.393Z","avatar_url":"https://github.com/yishenggudou.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"=====================================\nsphinxcontrib-sphinx-rest-api-doc\n=====================================\n\n.. image:: https://travis-ci.org/yishenggudou/sphinxcontrib-sphinx-rest-api-doc.svg?branch=master\n    :target: https://travis-ci.org/yishenggudou/sphinxcontrib-sphinx-rest-api-doc\n\n.. image:: https://badge.fury.io/py/sphinxcontrib-sphinx-rest-api-doc.svg\n    :target: https://badge.fury.io/py/sphinxcontrib-sphinx-rest-api-doc\n\n\na tools for sphinx gen doc from json api\n\nOverview\n--------\n\nAdd a longer description here.\n\nINSTALL\n--------------------\n\n.. code-block:: bash\n\n    pip install sphinxcontrib-sphinx-rest-api-doc\n\nBasic usage\n----------------------\n\n.. code-block:: rst\n\n   .. rest: path_to_model.json\n\n\nexample in model file\n----------------------\n\n\n\n.. code-block:: json\n\n   {\n  \"title\": \"测试资源\",\n  \"desc\": \"测试测试测试\",\n  \"method\": {\n    \"get\": {\n      \"list\": false,\n      \"path\": \"/api/xx/xx/xx\",\n      \"params\": {\n        \"id\":\"ddede\"\n      },\n      \"desc\": \"dwdwedewfeferferferferfewr\",\n      \"headers\": {\n        \"auth\":\"auth\"\n      },\n      \"codes\": {\n        \"400\":\"de\",\n        \"200\":\"2\"\n      }\n    }\n  },\n  \"model\": {\n    \"id\":\"\",\n    \"desc\":\"dede\"\n  }\n   }\n\n\n\nCONFIG\n----------\n\n\nin config.py\n\n.. code-block:: py\n    \n   extensions += ['sphinxcontrib.SphinxRest',]\n   rest_api_source_root = os.path.join(PROJECT_DIR, \"_static\", \"models\")\n   rest_api_domain = \"timger.com.cn\"\n   rest_api_http_request_example_title = \"Request Example\"\n   rest_api_http_response_example_title = \"Response Example\"\n\n\nLinks\n-----\n\n- Source: https://github.com/yishenggudou/sphinxcontrib-sphinx-rest-api-doc\n- Bugs: https://github.com/yishenggudou/sphinxcontrib-sphinx-rest-api-doc/issues\n- BLOG: http://www.timger.com.cn/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyishenggudou%2Fsphinx-rest-api-doc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyishenggudou%2Fsphinx-rest-api-doc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyishenggudou%2Fsphinx-rest-api-doc/lists"}