{"id":1171803,"date":"2025-01-15T16:40:03","date_gmt":"2025-01-15T08:40:03","guid":{"rendered":"https:\/\/docs.pingcode.com\/ask\/ask-ask\/1171803.html"},"modified":"2025-01-15T16:40:07","modified_gmt":"2025-01-15T08:40:07","slug":"%e5%a6%82%e4%bd%95%e6%9f%a5%e7%9c%8bpython%e7%9a%84api%e6%96%87%e6%a1%a3","status":"publish","type":"post","link":"https:\/\/docs.pingcode.com\/ask\/ask-ask\/1171803.html","title":{"rendered":"\u5982\u4f55\u67e5\u770bpython\u7684api\u6587\u6863"},"content":{"rendered":"<p style=\"text-align:center;\" ><img decoding=\"async\" src=\"https:\/\/cdn-kb.worktile.com\/kb\/wp-content\/uploads\/2024\/04\/26074042\/8fb1a6f8-7b5f-4ab0-9c02-33b8d2a4254c.webp\" alt=\"\u5982\u4f55\u67e5\u770bpython\u7684api\u6587\u6863\" \/><\/p>\n<p><p> \u67e5\u770bPython\u7684API\u6587\u6863\u7684\u65b9\u6cd5\u6709\u5f88\u591a\u79cd\uff0c\u4e3b\u8981\u5305\u62ec<strong>\u4f7f\u7528\u5b98\u65b9\u6587\u6863\u3001\u4f7f\u7528\u5185\u7f6ehelp()\u51fd\u6570\u3001\u5229\u7528pydoc\u6a21\u5757\u3001\u4f7f\u7528IDE\u7684\u5e2e\u52a9\u529f\u80fd\u3001\u5728\u7ebf\u6587\u6863\u548c\u6559\u7a0b\u7f51\u7ad9<\/strong>\u3002\u5176\u4e2d\uff0c\u6700\u4e3a\u63a8\u8350\u7684\u662f\u4f7f\u7528Python\u7684\u5b98\u65b9\u6587\u6863\uff0c\u56e0\u4e3a\u5b83\u8be6\u7ec6\u4e14\u5168\u9762\uff0c\u6db5\u76d6\u4e86\u6240\u6709\u6807\u51c6\u5e93\u548c\u51fd\u6570\u7684\u7528\u6cd5\u3002\u4e0b\u9762\u6211\u4eec\u8be6\u7ec6\u4ecb\u7ecd\u8fd9\u4e9b\u65b9\u6cd5\u3002<\/p>\n<\/p>\n<p><p>\u4e00\u3001\u5b98\u65b9\u6587\u6863<\/p>\n<\/p>\n<p><p>Python\u7684\u5b98\u65b9\u6587\u6863\u662f\u6700\u6743\u5a01\u7684\u53c2\u8003\u8d44\u6599\u3002\u65e0\u8bba\u4f60\u662f\u521d\u5b66\u8005\u8fd8\u662f\u9ad8\u7ea7\u7528\u6237\uff0c\u5b98\u65b9\u6587\u6863\u90fd\u80fd\u63d0\u4f9b\u4f60\u6240\u9700\u7684\u4fe1\u606f\u3002<\/p>\n<\/p>\n<ol>\n<li><strong>\u4f7f\u7528Python\u5b98\u65b9\u7f51\u7ad9<\/strong><\/li>\n<\/ol>\n<p><p>Python\u5b98\u65b9\u7f51\u7ad9\u63d0\u4f9b\u4e86\u8be6\u7ec6\u7684API\u6587\u6863\uff0c\u5305\u62ec\u6807\u51c6\u5e93\u3001\u5185\u7f6e\u51fd\u6570\u3001\u6a21\u5757\u3001\u7c7b\u548c\u65b9\u6cd5\u7684\u7528\u6cd5\u8bf4\u660e\u3002\u4f60\u53ef\u4ee5\u8bbf\u95ee<a href=\"https:\/\/docs.python.org\/3\/\">Python\u5b98\u65b9\u6587\u6863<\/a>\u6765\u67e5\u627e\u4f60\u9700\u8981\u7684\u4fe1\u606f\u3002\u5b98\u7f51\u6587\u6863\u975e\u5e38\u8be6\u7ec6\uff0c\u6db5\u76d6\u4e86Python\u8bed\u8a00\u7684\u5404\u4e2a\u65b9\u9762\uff0c\u5305\u62ec\u8bed\u6cd5\u3001\u6807\u51c6\u5e93\u3001\u6a21\u5757\u3001\u7c7b\u548c\u51fd\u6570\u7684\u8be6\u7ec6\u8bf4\u660e\uff0c\u4ee5\u53ca\u793a\u4f8b\u4ee3\u7801\u3002<\/p>\n<\/p>\n<ol start=\"2\">\n<li><strong>\u6587\u6863\u7ed3\u6784<\/strong><\/li>\n<\/ol>\n<p><p>\u5b98\u65b9\u6587\u6863\u901a\u5e38\u5206\u4e3a\u51e0\u4e2a\u4e3b\u8981\u90e8\u5206\uff1a<\/p>\n<\/p>\n<ul>\n<li><strong>\u6559\u7a0b<\/strong>\uff1a\u9002\u5408\u521d\u5b66\u8005\uff0c\u5e2e\u52a9\u4ed6\u4eec\u5feb\u901f\u5165\u95e8Python\u3002<\/li>\n<li><strong>\u5e93\u5f15\u7528<\/strong>\uff1a\u8be6\u7ec6\u4ecb\u7ecd\u4e86Python\u6807\u51c6\u5e93\u4e2d\u7684\u6a21\u5757\u3001\u7c7b\u548c\u51fd\u6570\u3002<\/li>\n<li><strong>\u8bed\u8a00\u53c2\u8003<\/strong>\uff1a\u8be6\u7ec6\u63cf\u8ff0\u4e86Python\u7684\u8bed\u6cd5\u548c\u8bed\u4e49\u3002<\/li>\n<li><strong>\u6269\u5c55\u548c\u5d4c\u5165<\/strong>\uff1a\u4ecb\u7ecd\u5982\u4f55\u7528C\u6216C++\u6269\u5c55Python\uff0c\u6216\u5c06Python\u5d4c\u5165\u5176\u4ed6\u5e94\u7528\u7a0b\u5e8f\u3002<\/li>\n<li><strong>\u5b89\u88c5\u548c\u53d1\u884c<\/strong>\uff1a\u6307\u5bfc\u5982\u4f55\u5b89\u88c5Python\u548c\u53d1\u884cPython\u5e94\u7528\u3002<\/li>\n<\/ul>\n<p><p>\u4e8c\u3001\u5185\u7f6ehelp()\u51fd\u6570<\/p>\n<\/p>\n<p><p>Python\u81ea\u5e26\u7684help()\u51fd\u6570\u662f\u4e00\u4e2a\u975e\u5e38\u65b9\u4fbf\u7684\u5de5\u5177\uff0c\u80fd\u5728\u4ea4\u4e92\u5f0f\u89e3\u91ca\u5668\u4e2d\u5373\u65f6\u67e5\u770b\u6587\u6863\u3002<\/p>\n<\/p>\n<ol>\n<li><strong>\u4f7f\u7528\u65b9\u6cd5<\/strong><\/li>\n<\/ol>\n<p><p>\u5728Python\u4ea4\u4e92\u5f0f\u89e3\u91ca\u5668\u4e2d\uff0c\u4f60\u53ef\u4ee5\u4f7f\u7528help()\u51fd\u6570\u6765\u67e5\u770b\u4efb\u4f55\u6a21\u5757\u3001\u7c7b\u3001\u51fd\u6570\u6216\u65b9\u6cd5\u7684\u6587\u6863\u3002\u4f8b\u5982\uff1a<\/p>\n<\/p>\n<p><pre><code class=\"language-python\">help(print)<\/p>\n<p><\/code><\/pre>\n<\/p>\n<p><p>\u8fd9\u5c06\u663e\u793aprint\u51fd\u6570\u7684\u6587\u6863\u5b57\u7b26\u4e32\uff0c\u5305\u62ec\u53c2\u6570\u3001\u7528\u6cd5\u548c\u793a\u4f8b\u3002<\/p>\n<\/p>\n<ol start=\"2\">\n<li><strong>\u67e5\u627e\u6a21\u5757\u6587\u6863<\/strong><\/li>\n<\/ol>\n<p><p>\u4f60\u8fd8\u53ef\u4ee5\u901a\u8fc7import\u6a21\u5757\u540d\u5e76\u4f7f\u7528help(\u6a21\u5757\u540d)\u6765\u67e5\u770b\u6a21\u5757\u7684\u6587\u6863\u3002\u4f8b\u5982\uff1a<\/p>\n<\/p>\n<p><pre><code class=\"language-python\">import math<\/p>\n<p>help(math)<\/p>\n<p><\/code><\/pre>\n<\/p>\n<p><p>\u8fd9\u5c06\u663e\u793amath\u6a21\u5757\u7684\u6240\u6709\u51fd\u6570\u548c\u65b9\u6cd5\u7684\u8be6\u7ec6\u6587\u6863\u3002<\/p>\n<\/p>\n<p><p>\u4e09\u3001pydoc\u6a21\u5757<\/p>\n<\/p>\n<p><p>pydoc\u662fPython\u5185\u7f6e\u7684\u4e00\u4e2a\u6a21\u5757\uff0c\u7528\u4e8e\u751f\u6210\u548c\u67e5\u770bPython\u6a21\u5757\u7684\u6587\u6863\u3002<\/p>\n<\/p>\n<ol>\n<li><strong>\u547d\u4ee4\u884c\u4f7f\u7528<\/strong><\/li>\n<\/ol>\n<p><p>\u4f60\u53ef\u4ee5\u5728\u547d\u4ee4\u884c\u4e2d\u4f7f\u7528pydoc\u547d\u4ee4\u6765\u67e5\u770b\u6587\u6863\u3002\u4f8b\u5982\uff1a<\/p>\n<\/p>\n<p><pre><code class=\"language-sh\">pydoc print<\/p>\n<p><\/code><\/pre>\n<\/p>\n<p><p>\u8fd9\u5c06\u663e\u793aprint\u51fd\u6570\u7684\u6587\u6863\u3002<\/p>\n<\/p>\n<ol start=\"2\">\n<li><strong>\u751f\u6210HTML\u6587\u6863<\/strong><\/li>\n<\/ol>\n<p><p>\u4f60\u8fd8\u53ef\u4ee5\u4f7f\u7528pydoc\u751f\u6210HTML\u683c\u5f0f\u7684\u6587\u6863\uff0c\u5e76\u5728\u6d4f\u89c8\u5668\u4e2d\u67e5\u770b\u3002\u4f8b\u5982\uff1a<\/p>\n<\/p>\n<p><pre><code class=\"language-sh\">pydoc -w module_name<\/p>\n<p><\/code><\/pre>\n<\/p>\n<p><p>\u8fd9\u5c06\u751f\u6210module_name.html\u6587\u4ef6\uff0c\u4f60\u53ef\u4ee5\u5728\u6d4f\u89c8\u5668\u4e2d\u6253\u5f00\u5b83\u6765\u67e5\u770b\u8be6\u7ec6\u7684\u6587\u6863\u3002<\/p>\n<\/p>\n<p><p>\u56db\u3001IDE\u7684\u5e2e\u52a9\u529f\u80fd<\/p>\n<\/p>\n<p><p>\u73b0\u4ee3\u7684IDE\uff08\u96c6\u6210\u5f00\u53d1\u73af\u5883\uff09\u901a\u5e38\u90fd\u5185\u7f6e\u4e86\u67e5\u770bAPI\u6587\u6863\u7684\u529f\u80fd\uff0c\u4f7f\u5f97\u67e5\u9605\u6587\u6863\u66f4\u52a0\u65b9\u4fbf\u5feb\u6377\u3002<\/p>\n<\/p>\n<ol>\n<li><strong>PyCharm<\/strong><\/li>\n<\/ol>\n<p><p>PyCharm\u662f\u4e00\u4e2a\u975e\u5e38\u6d41\u884c\u7684Python IDE\uff0c\u5b83\u5185\u7f6e\u4e86\u5f3a\u5927\u7684\u6587\u6863\u67e5\u770b\u529f\u80fd\u3002\u4f60\u53ef\u4ee5\u5728\u4ee3\u7801\u7f16\u8f91\u5668\u4e2d\u5c06\u9f20\u6807\u60ac\u505c\u5728\u67d0\u4e2a\u51fd\u6570\u6216\u7c7b\u540d\u4e0a\uff0c\u7136\u540e\u6309\u4e0b\u5feb\u6377\u952e\uff08\u901a\u5e38\u662fCtrl+Q\uff09\uff0c\u5373\u53ef\u5f39\u51fa\u8be5\u51fd\u6570\u6216\u7c7b\u7684\u8be6\u7ec6\u6587\u6863\u3002<\/p>\n<\/p>\n<ol start=\"2\">\n<li><strong>VS Code<\/strong><\/li>\n<\/ol>\n<p><p>VS Code\u662f\u53e6\u4e00\u4e2a\u975e\u5e38\u6d41\u884c\u7684\u7f16\u8f91\u5668\uff0c\u652f\u6301Python\u5f00\u53d1\u3002\u5b89\u88c5Python\u6269\u5c55\u540e\uff0c\u4f60\u53ef\u4ee5\u5728\u7f16\u8f91\u5668\u4e2d\u4f7f\u7528\u5feb\u6377\u952e\uff08\u901a\u5e38\u662fF12\u6216Ctrl+Shift+Space\uff09\u67e5\u770b\u51fd\u6570\u6216\u7c7b\u7684\u6587\u6863\u3002<\/p>\n<\/p>\n<p><p>\u4e94\u3001\u5728\u7ebf\u6587\u6863\u548c\u6559\u7a0b\u7f51\u7ad9<\/p>\n<\/p>\n<p><p>\u9664\u4e86\u5b98\u65b9\u6587\u6863\uff0c\u8fd8\u6709\u5f88\u591a\u5728\u7ebf\u8d44\u6e90\u53ef\u4ee5\u5e2e\u52a9\u4f60\u67e5\u9605Python API\u6587\u6863\u3002<\/p>\n<\/p>\n<ol>\n<li><strong>Read the Docs<\/strong><\/li>\n<\/ol>\n<p><p>Read the Docs\u662f\u4e00\u4e2a\u6258\u7ba1\u6587\u6863\u7684\u7f51\u7ad9\uff0c\u5f88\u591a\u5f00\u6e90\u9879\u76ee\u90fd\u5728\u4e0a\u9762\u6258\u7ba1\u4e86\u4ed6\u4eec\u7684\u6587\u6863\u3002\u4f60\u53ef\u4ee5\u5728<a href=\"https:\/\/readthedocs.org\/\">Read the Docs<\/a>\u4e0a\u627e\u5230\u5f88\u591aPython\u5e93\u548c\u6846\u67b6\u7684\u6587\u6863\u3002<\/p>\n<\/p>\n<ol start=\"2\">\n<li><strong>Stack Overflow<\/strong><\/li>\n<\/ol>\n<p><p>Stack Overflow\u662f\u4e00\u4e2a\u7a0b\u5e8f\u5458\u95ee\u7b54\u7f51\u7ad9\uff0c\u5f88\u591a\u95ee\u9898\u5df2\u7ecf\u6709\u4e86\u8be6\u7ec6\u7684\u89e3\u7b54\u3002\u4f60\u53ef\u4ee5\u5728<a href=\"https:\/\/stackoverflow.com\/\">Stack Overflow<\/a>\u4e0a\u641c\u7d22\u4f60\u9047\u5230\u7684\u95ee\u9898\uff0c\u901a\u5e38\u80fd\u627e\u5230\u8be6\u7ec6\u7684\u89e3\u7b54\u548c\u793a\u4f8b\u4ee3\u7801\u3002<\/p>\n<\/p>\n<ol start=\"3\">\n<li><strong>\u6559\u7a0b\u7f51\u7ad9<\/strong><\/li>\n<\/ol>\n<p><p>\u5f88\u591a\u7f16\u7a0b\u6559\u7a0b\u7f51\u7ad9\u4e5f\u63d0\u4f9b\u4e86\u8be6\u7ec6\u7684Python API\u6587\u6863\u548c\u793a\u4f8b\u4ee3\u7801\u3002\u4f8b\u5982\uff0c<a href=\"https:\/\/www.geeksforgeeks.org\/\">GeeksforGeeks<\/a> \u548c <a href=\"https:\/\/realpython.com\/\">Real Python<\/a> \u90fd\u662f\u5f88\u597d\u7684\u8d44\u6e90\u3002<\/p>\n<\/p>\n<p><p>\u516d\u3001\u4f7f\u7528Sphinx\u751f\u6210\u6587\u6863<\/p>\n<\/p>\n<p><p>Sphinx\u662f\u4e00\u4e2a\u7528\u4e8e\u751f\u6210\u6587\u6863\u7684\u5de5\u5177\uff0c\u7279\u522b\u9002\u5408\u7528\u6765\u751f\u6210Python\u9879\u76ee\u7684\u6587\u6863\u3002<\/p>\n<\/p>\n<ol>\n<li><strong>\u5b89\u88c5Sphinx<\/strong><\/li>\n<\/ol>\n<p><p>\u4f60\u53ef\u4ee5\u4f7f\u7528pip\u5b89\u88c5Sphinx\uff1a<\/p>\n<\/p>\n<p><pre><code class=\"language-sh\">pip install sphinx<\/p>\n<p><\/code><\/pre>\n<\/p>\n<ol start=\"2\">\n<li><strong>\u521b\u5efa\u6587\u6863<\/strong><\/li>\n<\/ol>\n<p><p>\u5728\u4f60\u7684\u9879\u76ee\u76ee\u5f55\u4e2d\u8fd0\u884c\u4ee5\u4e0b\u547d\u4ee4\u6765\u521d\u59cb\u5316Sphinx\uff1a<\/p>\n<\/p>\n<p><pre><code class=\"language-sh\">sphinx-quickstart<\/p>\n<p><\/code><\/pre>\n<\/p>\n<p><p>\u8fd9\u5c06\u521b\u5efa\u4e00\u4e2a\u57fa\u672c\u7684\u6587\u6863\u7ed3\u6784\u3002\u7136\u540e\uff0c\u4f60\u53ef\u4ee5\u5728conf.py\u6587\u4ef6\u4e2d\u914d\u7f6eSphinx\uff0c\u5e76\u5728index.rst\u6587\u4ef6\u4e2d\u7f16\u5199\u4f60\u7684\u6587\u6863\u3002<\/p>\n<\/p>\n<ol start=\"3\">\n<li><strong>\u751f\u6210HTML\u6587\u6863<\/strong><\/li>\n<\/ol>\n<p><p>\u5728\u9879\u76ee\u76ee\u5f55\u4e2d\u8fd0\u884c\u4ee5\u4e0b\u547d\u4ee4\u751f\u6210HTML\u683c\u5f0f\u7684\u6587\u6863\uff1a<\/p>\n<\/p>\n<p><pre><code class=\"language-sh\">make html<\/p>\n<p><\/code><\/pre>\n<\/p>\n<p><p>\u751f\u6210\u7684HTML\u6587\u6863\u5c06\u4f4d\u4e8e_build\/html\u76ee\u5f55\u4e2d\uff0c\u4f60\u53ef\u4ee5\u5728\u6d4f\u89c8\u5668\u4e2d\u6253\u5f00index.html\u6587\u4ef6\u6765\u67e5\u770b\u3002<\/p>\n<\/p>\n<p><p>\u4e03\u3001\u4f7f\u7528Docstring\u548c\u6ce8\u91ca<\/p>\n<\/p>\n<p><p>\u5728\u7f16\u5199\u4ee3\u7801\u65f6\uff0c\u826f\u597d\u7684\u6587\u6863\u548c\u6ce8\u91ca\u4e60\u60ef\u4e5f\u975e\u5e38\u91cd\u8981\u3002<\/p>\n<\/p>\n<ol>\n<li><strong>Docstring<\/strong><\/li>\n<\/ol>\n<p><p>Python\u652f\u6301\u5728\u51fd\u6570\u3001\u7c7b\u548c\u6a21\u5757\u4e2d\u4f7f\u7528\u4e09\u5f15\u53f7\u5b57\u7b26\u4e32\uff08&quot;&quot;&quot;\uff09\u7f16\u5199\u6587\u6863\u5b57\u7b26\u4e32\uff08Docstring\uff09\u3002\u8fd9\u4e9b\u6587\u6863\u5b57\u7b26\u4e32\u53ef\u4ee5\u901a\u8fc7help()\u51fd\u6570\u67e5\u770b\uff0c\u4e5f\u53ef\u4ee5\u7528\u4e8e\u751f\u6210\u6587\u6863\u3002\u4f8b\u5982\uff1a<\/p>\n<\/p>\n<p><pre><code class=\"language-python\">def add(a, b):<\/p>\n<p>    &quot;&quot;&quot;<\/p>\n<p>    \u8fd4\u56de\u4e24\u4e2a\u6570\u7684\u548c\u3002<\/p>\n<p>    \u53c2\u6570:<\/p>\n<p>    a -- \u7b2c\u4e00\u4e2a\u6570<\/p>\n<p>    b -- \u7b2c\u4e8c\u4e2a\u6570<\/p>\n<p>    \u8fd4\u56de\u503c:<\/p>\n<p>    \u4e24\u4e2a\u6570\u7684\u548c<\/p>\n<p>    &quot;&quot;&quot;<\/p>\n<p>    return a + b<\/p>\n<p><\/code><\/pre>\n<\/p>\n<ol start=\"2\">\n<li><strong>\u6ce8\u91ca<\/strong><\/li>\n<\/ol>\n<p><p>\u5728\u4ee3\u7801\u4e2d\u6dfb\u52a0\u6ce8\u91ca\u53ef\u4ee5\u5e2e\u52a9\u4ed6\u4eba\u7406\u89e3\u4f60\u7684\u4ee3\u7801\u3002\u6ce8\u91ca\u901a\u5e38\u4f7f\u7528#\u7b26\u53f7\u3002\u4f8b\u5982\uff1a<\/p>\n<\/p>\n<p><pre><code class=\"language-python\"># \u8ba1\u7b97\u4e24\u4e2a\u6570\u7684\u548c<\/p>\n<p>result = add(3, 5)<\/p>\n<p><\/code><\/pre>\n<\/p>\n<p><p>\u901a\u8fc7\u4ee5\u4e0a\u65b9\u6cd5\uff0c\u4f60\u53ef\u4ee5\u65b9\u4fbf\u5730\u67e5\u770b\u548c\u7f16\u5199Python\u7684API\u6587\u6863\uff0c\u63d0\u9ad8\u4ee3\u7801\u7684\u53ef\u8bfb\u6027\u548c\u7ef4\u62a4\u6027\u3002<\/p>\n<\/p>\n<p><p>\u516b\u3001\u4f7f\u7528\u5728\u7ebfAPI\u6587\u6863\u751f\u6210\u5668<\/p>\n<\/p>\n<p><p>\u5982\u679c\u4f60\u6b63\u5728\u5f00\u53d1\u4e00\u4e2aPython\u9879\u76ee\uff0c\u5e76\u5e0c\u671b\u4e3a\u4f60\u7684\u9879\u76ee\u751f\u6210API\u6587\u6863\uff0c\u53ef\u4ee5\u4f7f\u7528\u4e00\u4e9b\u5728\u7ebfAPI\u6587\u6863\u751f\u6210\u5668\u3002<\/p>\n<\/p>\n<ol>\n<li><strong>Swagger<\/strong><\/li>\n<\/ol>\n<p><p>Swagger\u662f\u4e00\u79cd\u7528\u4e8e\u751f\u6210RESTful API\u6587\u6863\u7684\u5de5\u5177\u3002\u4f60\u53ef\u4ee5\u4f7f\u7528Swagger\u6765\u751f\u6210Python\u9879\u76ee\u7684API\u6587\u6863\u3002\u9996\u5148\uff0c\u5b89\u88c5Swagger\uff1a<\/p>\n<\/p>\n<p><pre><code class=\"language-sh\">pip install swagger<\/p>\n<p><\/code><\/pre>\n<\/p>\n<p><p>\u7136\u540e\uff0c\u6309\u7167Swagger\u7684\u6587\u6863\u6307\u5bfc\uff0c\u5c06\u4f60\u7684API\u5b9a\u4e49\u6587\u4ef6\u7f16\u5199\u6210\u7b26\u5408OpenAPI\u89c4\u8303\u7684\u683c\u5f0f\u3002\u6700\u540e\uff0c\u4f7f\u7528Swagger UI\u6765\u751f\u6210\u548c\u67e5\u770bAPI\u6587\u6863\u3002<\/p>\n<\/p>\n<ol start=\"2\">\n<li><strong>Apiary<\/strong><\/li>\n<\/ol>\n<p><p>Apiary\u662f\u53e6\u4e00\u4e2a\u6d41\u884c\u7684API\u6587\u6863\u751f\u6210\u5668\u3002\u4f60\u53ef\u4ee5\u4f7f\u7528Apiary\u7f16\u5199API\u84dd\u56fe\uff0c\u7136\u540e\u751f\u6210API\u6587\u6863\u3002\u9996\u5148\uff0c\u6ce8\u518c\u4e00\u4e2aApiary\u8d26\u6237\uff0c\u5e76\u521b\u5efa\u4e00\u4e2a\u65b0\u7684API\u9879\u76ee\u3002\u7136\u540e\uff0c\u7f16\u5199API\u84dd\u56fe\u6587\u4ef6\uff0c\u5e76\u4f7f\u7528Apiary\u63d0\u4f9b\u7684\u5de5\u5177\u751f\u6210\u6587\u6863\u3002<\/p>\n<\/p>\n<p><p>\u4e5d\u3001\u4f7f\u7528\u7b2c\u4e09\u65b9\u6587\u6863\u5de5\u5177<\/p>\n<\/p>\n<p><p>\u9664\u4e86\u5b98\u65b9\u6587\u6863\u548c\u5728\u7ebf\u751f\u6210\u5668\uff0c\u8fd8\u6709\u8bb8\u591a\u7b2c\u4e09\u65b9\u6587\u6863\u5de5\u5177\u53ef\u4ee5\u5e2e\u52a9\u4f60\u751f\u6210\u548c\u67e5\u770bPython API\u6587\u6863\u3002<\/p>\n<\/p>\n<ol>\n<li><strong>Doxygen<\/strong><\/li>\n<\/ol>\n<p><p>Doxygen\u662f\u4e00\u4e2a\u5f3a\u5927\u7684\u6587\u6863\u751f\u6210\u5de5\u5177\uff0c\u652f\u6301\u591a\u79cd\u7f16\u7a0b\u8bed\u8a00\uff0c\u5305\u62ecPython\u3002\u4f60\u53ef\u4ee5\u4f7f\u7528Doxygen\u751f\u6210Python\u9879\u76ee\u7684API\u6587\u6863\u3002\u9996\u5148\uff0c\u5b89\u88c5Doxygen\uff1a<\/p>\n<\/p>\n<p><pre><code class=\"language-sh\">sudo apt-get install doxygen<\/p>\n<p><\/code><\/pre>\n<\/p>\n<p><p>\u7136\u540e\uff0c\u521b\u5efa\u4e00\u4e2aDoxyfile\u914d\u7f6e\u6587\u4ef6\uff0c\u5e76\u6309\u7167Doxygen\u7684\u6587\u6863\u6307\u5bfc\u7f16\u5199\u914d\u7f6e\u6587\u4ef6\u3002\u6700\u540e\uff0c\u8fd0\u884cDoxygen\u751f\u6210\u6587\u6863\u3002<\/p>\n<\/p>\n<ol start=\"2\">\n<li><strong>MkDocs<\/strong><\/li>\n<\/ol>\n<p><p>MkDocs\u662f\u4e00\u4e2a\u7528\u4e8e\u751f\u6210\u9759\u6001\u7ad9\u70b9\u7684\u6587\u6863\u5de5\u5177\uff0c\u7279\u522b\u9002\u5408\u7f16\u5199\u9879\u76ee\u6587\u6863\u3002\u9996\u5148\uff0c\u5b89\u88c5MkDocs\uff1a<\/p>\n<\/p>\n<p><pre><code class=\"language-sh\">pip install mkdocs<\/p>\n<p><\/code><\/pre>\n<\/p>\n<p><p>\u7136\u540e\uff0c\u521b\u5efa\u4e00\u4e2aMkDocs\u9879\u76ee\uff0c\u5e76\u7f16\u5199\u4f60\u7684\u6587\u6863\u3002\u6700\u540e\uff0c\u8fd0\u884c\u4ee5\u4e0b\u547d\u4ee4\u751f\u6210\u9759\u6001\u7ad9\u70b9\uff1a<\/p>\n<\/p>\n<p><pre><code class=\"language-sh\">mkdocs build<\/p>\n<p><\/code><\/pre>\n<\/p>\n<p><p>\u751f\u6210\u7684\u6587\u6863\u5c06\u4f4d\u4e8esite\u76ee\u5f55\u4e2d\uff0c\u4f60\u53ef\u4ee5\u5728\u6d4f\u89c8\u5668\u4e2d\u6253\u5f00index.html\u6587\u4ef6\u6765\u67e5\u770b\u3002<\/p>\n<\/p>\n<p><p>\u5341\u3001\u4f7f\u7528Python\u5e93\u7684\u6587\u6863<\/p>\n<\/p>\n<p><p>\u5f88\u591a\u6d41\u884c\u7684Python\u5e93\u90fd\u6709\u81ea\u5df1\u7684API\u6587\u6863\uff0c\u4f60\u53ef\u4ee5\u901a\u8fc7\u4ee5\u4e0b\u65b9\u6cd5\u67e5\u770b\u8fd9\u4e9b\u6587\u6863\u3002<\/p>\n<\/p>\n<ol>\n<li><strong>NumPy<\/strong><\/li>\n<\/ol>\n<p><p>NumPy\u662f\u4e00\u4e2a\u7528\u4e8e\u79d1\u5b66\u8ba1\u7b97\u7684\u6d41\u884c\u5e93\u3002\u4f60\u53ef\u4ee5\u8bbf\u95ee<a href=\"https:\/\/numpy.org\/doc\/\">NumPy\u5b98\u65b9\u6587\u6863<\/a>\u67e5\u770b\u8be6\u7ec6\u7684API\u6587\u6863\u3002<\/p>\n<\/p>\n<ol start=\"2\">\n<li><strong>Pandas<\/strong><\/li>\n<\/ol>\n<p><p>Pandas\u662f\u4e00\u4e2a\u7528\u4e8e\u6570\u636e\u5206\u6790\u7684\u6d41\u884c\u5e93\u3002\u4f60\u53ef\u4ee5\u8bbf\u95ee<a href=\"https:\/\/pandas.pydata.org\/pandas-docs\/stable\/\">Pandas\u5b98\u65b9\u6587\u6863<\/a>\u67e5\u770b\u8be6\u7ec6\u7684API\u6587\u6863\u3002<\/p>\n<\/p>\n<ol start=\"3\">\n<li><strong>Django<\/strong><\/li>\n<\/ol>\n<p><p>Django\u662f\u4e00\u4e2a\u6d41\u884c\u7684Web\u6846\u67b6\u3002\u4f60\u53ef\u4ee5\u8bbf\u95ee<a href=\"https:\/\/docs.djangoproject.com\/en\/stable\/\">Django\u5b98\u65b9\u6587\u6863<\/a>\u67e5\u770b\u8be6\u7ec6\u7684API\u6587\u6863\u3002<\/p>\n<\/p>\n<p><p>\u901a\u8fc7\u4ee5\u4e0a\u65b9\u6cd5\uff0c\u4f60\u53ef\u4ee5\u65b9\u4fbf\u5730\u67e5\u770b\u548c\u7f16\u5199Python\u7684API\u6587\u6863\uff0c\u63d0\u5347\u5f00\u53d1\u6548\u7387\u548c\u4ee3\u7801\u8d28\u91cf\u3002\u65e0\u8bba\u4f60\u662f\u521d\u5b66\u8005\u8fd8\u662f\u9ad8\u7ea7\u7528\u6237\uff0c\u826f\u597d\u7684\u6587\u6863\u4e60\u60ef\u90fd\u662f\u975e\u5e38\u91cd\u8981\u7684\u3002\u5e0c\u671b\u8fd9\u7bc7\u6587\u7ae0\u80fd\u5bf9\u4f60\u6709\u6240\u5e2e\u52a9\u3002<\/p>\n<\/p>\n<h2><strong>\u76f8\u5173\u95ee\u7b54FAQs\uff1a<\/strong><\/h2>\n<p> <strong>\u5982\u4f55\u5feb\u901f\u627e\u5230Python API\u6587\u6863\u7684\u76f8\u5173\u94fe\u63a5\uff1f<\/strong><br \/>\u60a8\u53ef\u4ee5\u901a\u8fc7\u8bbf\u95eePython\u7684\u5b98\u65b9\u7f51\u7ad9\uff08python.org\uff09\u627e\u5230\u6700\u65b0\u7684API\u6587\u6863\u3002\u5728\u9996\u9875\u7684\u5bfc\u822a\u680f\u4e2d\uff0c\u70b9\u51fb\u201c\u6587\u6863\u201d\u9009\u9879\uff0c\u60a8\u5c06\u770b\u5230\u5404\u4e2a\u7248\u672c\u7684Python\u6587\u6863\u94fe\u63a5\u3002\u9009\u62e9\u60a8\u6b63\u5728\u4f7f\u7528\u7684Python\u7248\u672c\uff0c\u5c31\u53ef\u4ee5\u76f4\u63a5\u8fdb\u5165\u76f8\u5e94\u7684API\u6587\u6863\u3002<\/p>\n<p><strong>\u662f\u5426\u53ef\u4ee5\u79bb\u7ebf\u67e5\u770bPython API\u6587\u6863\uff1f<\/strong><br \/>\u662f\u7684\uff0c\u60a8\u53ef\u4ee5\u4e0b\u8f7dPython\u7684\u6587\u6863\u4ee5\u4fbf\u4e8e\u79bb\u7ebf\u67e5\u770b\u3002\u8bbf\u95eePython\u5b98\u7f51\u7684\u6587\u6863\u9875\u9762\uff0c\u901a\u5e38\u4f1a\u6709\u4e00\u4e2a\u201c\u4e0b\u8f7d\u201d\u9009\u9879\uff0c\u60a8\u53ef\u4ee5\u9009\u62e9\u5408\u9002\u7684\u683c\u5f0f\uff08\u5982HTML\u6216PDF\uff09\u4e0b\u8f7d\u5b8c\u6574\u7684\u6587\u6863\u5305\u3002\u4e0b\u8f7d\u540e\uff0c\u60a8\u53ef\u4ee5\u5728\u672c\u5730\u8ba1\u7b97\u673a\u4e0a\u67e5\u770b\u3002<\/p>\n<p><strong>Python API\u6587\u6863\u4e2d\u5305\u542b\u54ea\u4e9b\u91cd\u8981\u4fe1\u606f\uff1f<\/strong><br \/>Python API\u6587\u6863\u6db5\u76d6\u4e86\u6807\u51c6\u5e93\u7684\u5404\u4e2a\u6a21\u5757\u3001\u7c7b\u548c\u51fd\u6570\u7684\u8be6\u7ec6\u4fe1\u606f\u3002\u6bcf\u4e2a\u6761\u76ee\u901a\u5e38\u5305\u62ec\u529f\u80fd\u63cf\u8ff0\u3001\u53c2\u6570\u8bf4\u660e\u3001\u8fd4\u56de\u503c\u3001\u5f02\u5e38\u5904\u7406\u4ee5\u53ca\u793a\u4f8b\u4ee3\u7801\u7b49\u3002\u8fd9\u4e9b\u4fe1\u606f\u5bf9\u4e8e\u5f00\u53d1\u8005\u5728\u7f16\u5199\u4ee3\u7801\u65f6\u7406\u89e3\u548c\u4f7f\u7528Python\u6807\u51c6\u5e93\u975e\u5e38\u6709\u5e2e\u52a9\u3002<\/p>\n","protected":false},"excerpt":{"rendered":"\u67e5\u770bPython\u7684API\u6587\u6863\u7684\u65b9\u6cd5\u6709\u5f88\u591a\u79cd\uff0c\u4e3b\u8981\u5305\u62ec\u4f7f\u7528\u5b98\u65b9\u6587\u6863\u3001\u4f7f\u7528\u5185\u7f6ehelp()\u51fd\u6570\u3001\u5229\u7528pydoc\u6a21\u5757 [&hellip;]","protected":false},"author":3,"featured_media":1171810,"comment_status":"closed","ping_status":"","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[37],"tags":[],"acf":[],"_links":{"self":[{"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/posts\/1171803"}],"collection":[{"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/users\/3"}],"replies":[{"embeddable":true,"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/comments?post=1171803"}],"version-history":[{"count":"1","href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/posts\/1171803\/revisions"}],"predecessor-version":[{"id":1171811,"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/posts\/1171803\/revisions\/1171811"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/media\/1171810"}],"wp:attachment":[{"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/media?parent=1171803"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/categories?post=1171803"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/tags?post=1171803"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}