{"id":5799,"date":"2022-05-19T19:09:20","date_gmt":"2022-05-19T11:09:20","guid":{"rendered":"https:\/\/damogame.cn:15443\/wordpress\/?p=5799"},"modified":"2022-05-19T19:09:20","modified_gmt":"2022-05-19T11:09:20","slug":"%e4%bd%bf%e7%94%a8-oas%ef%bc%88openapi%e6%a0%87%e5%87%86%ef%bc%89%e6%9d%a5%e6%8f%8f%e8%bf%b0-web-api","status":"publish","type":"post","link":"https:\/\/i007.cc\/wordpress\/archives\/5799","title":{"rendered":"\u4f7f\u7528 OAS\uff08OpenAPI\u6807\u51c6\uff09\u6765\u63cf\u8ff0 Web API"},"content":{"rendered":"<p style=\"font-weight: 400;\"><a href=\"https:\/\/www.cnblogs.com\/yangxu-pro\/p\/12217617.html\">\u539f\u6587\u5730\u5740<\/a><\/p>\n<p>&nbsp;<\/p>\n<p><span data-contrast=\"auto\">\u65e0\u8bba\u54ea\u79cd\u7c7b\u578b\u7684Web API, \u90fd\u53ef\u80fd\u9700\u8981\u7ed9\u5176\u4ed6\u5f00\u53d1\u8005\u4f7f\u7528. \u6240\u4ee5API\u7684\u5f00\u53d1\u8005\u4f53\u9a8c\u662f\u5f88\u91cd\u8981\u7684. API\u7684\u5f00\u53d1\u8005\u4f53\u9a8c, \u7b80\u5199\u4e3a API DX (Developer Experience). \u5b83\u5305\u542b\u5f88\u591a\u4e1c\u897f, \u4f8b\u5982\u5982\u4f55\u4f7f\u7528API, \u6587\u6863, \u6280\u672f\u652f\u6301\u7b49\u7b49, \u4f46\u662f\u6700\u91cd\u8981\u7684\u8fd8\u662fAPI\u7684\u8bbe\u8ba1. \u5982\u679c API \u8bbe\u8ba1\u7684\u4e0d\u597d, \u90a3\u4e48\u4f7f\u7528\u8be5API\u6784\u5efa\u7684\u8f6f\u4ef6\u5c31\u9700\u8981\u589e\u52a0\u5728\u65f6\u95f4,\u4eba\u529b,\u91d1\u94b1\u7b49\u65b9\u9762\u7684\u6295\u5165. \u6709\u65f6\u5019API\u4f1a\u88ab\u9519\u7528, \u751a\u81f3\u5e26\u6765\u6bc1\u706d\u6027\u540e\u679c. \u6700\u540e\u62b1\u6028\u8be5API\u7b49\u7528\u6237\u8d8a\u6765\u8d8a\u591a, \u6162\u6162\u7684, \u5ba2\u6237\u5c31\u4f1a\u505c\u6b62\u4f7f\u7528\u8be5API.\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">API\u7684\u76ee\u7684\u662f\u8ba9\u4eba\u4eec\u53ef\u4ee5\u7b80\u5355\u7684\u4f7f\u7528\u5b83\u6765\u8fbe\u5230\u81ea\u5df1\u7684\u76ee\u7684. \u76ee\u524d\u884c\u4e1a\u5185\u6709\u5f88\u591aAPI\u98ce\u683c, \u4f8b\u5982: REST, gRPC, GraphQL, SOAP, RPC\u7b49\u7b49. \u4f46\u662f\u6bcf\u4e2a\u98ce\u683c\u90fd\u9075\u5faa\u4e00\u4e9b\u57fa\u672c\u7684\u8bbe\u8ba1\u539f\u5219.\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u00a0<\/span><\/p>\n<h1><span data-contrast=\"none\">\u7528\u6237\u5c31\u662f\u4e0a\u5e1d, \u4e3a\u7528\u6237\u8bbe\u8ba1API\u00a0<\/span><\/h1>\n<p>\u548c\u6784\u5efa\u4efb\u4f55\u4e1c\u897f\u4e00\u6837, \u4f60\u9700\u8981\u4e00\u4e2a\u8ba1\u5212, \u4f60\u9700\u8981\u5728\u771f\u6b63\u505a\u4e4b\u524d\u6765\u51b3\u5b9a\u4f60\u60f3\u8981\u7684\u662f\u4ec0\u4e48. API \u8bbe\u8ba1\u4e5f\u662f\u4e00\u6837\u7684.<\/p>\n<p><span data-contrast=\"auto\">API \u5e76\u4e0d\u662f\u7528\u6765\u76f2\u76ee\u7684\u66b4\u9732\u4e00\u4e9b\u6570\u636e\u6216\u4e1a\u52a1\u5904\u7406\u80fd\u529b. \u5b83\u5c31\u50cf\u6211\u4eec\u6bcf\u5929\u4f7f\u7528\u7684\u4efb\u4f55\u5f62\u5f0f\u7684\u63a5\u53e3\u4e00\u6837, \u4f8b\u5982\u5fae\u6ce2\u7089\u7684\u64cd\u4f5c\u6309\u94ae, \u662f\u6765\u5e2e\u52a9\u7528\u6237\u5b8c\u6210\u4ed6\u4eec\u7684\u76ee\u6807\u7684. \u6240\u4ee5\u9700\u8981\u4ece\u7528\u6237\u7684\u89c6\u89d2\u6765\u51b3\u5b9a\u4e00\u4e2aAPI\u7684\u8bbe\u8ba1\u76ee\u6807. \u5728\u6574\u4e2a\u8bbe\u8ba1\u8fc7\u7a0b\u4e2d, \u5fc5\u987b\u7262\u8bb0\u4ee5\u7528\u6237\u7684\u89c6\u89d2\u53bb\u8bbe\u8ba1, \u5982\u679c\u4ee5\u5f00\u53d1\u8005\u7684\u89d2\u5ea6\u53bb\u8bbe\u8ba1, \u90a3\u4e48\u95ee\u9898\u5c31\u5927\u4e86.\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u5982\u679c\u4ee5\u5f00\u53d1\u8005\u7684\u89c6\u89d2\u53bb\u8bbe\u8ba1\u7684API, \u90a3\u4e48\u901a\u5e38\u7684\u540e\u679c\u662f\u5f00\u53d1\u51fa\u7684API\u4f1a\u5f88\u6ce8\u91cd\u529f\u80fd\u5b9e\u73b0\u7684\u8fc7\u7a0b\u548c\u539f\u7406, \u800c\u4e0d\u662f\u7528\u6237\u5982\u4f55\u80fd\u7b80\u5355\u5e73\u6ed1\u7684\u4f7f\u7528\u8fd9\u4e2aAPI\u6765\u8fbe\u5230\u4ed6\u4eec\u7684\u76ee\u7684. \u6240\u4ee5\u4e00\u5b9a\u8981\u6ce8\u91cd\u7528\u6237\u7684\u9700\u6c42, \u800c\u4e0d\u8981\u8ba9\u5185\u90e8\u5b9e\u73b0\u7ec6\u8282, \u539f\u7406\u4ec0\u4e48\u7684\u6765\u9a9a\u6270\u7528\u6237. \u6700\u540e\u518d\u6b21\u5f3a\u8c03, \u8981\u8bbe\u8ba1\u51fa\u8ba9\u7528\u6237\u5bb9\u6613\u7406\u89e3\u548c\u5bb9\u6613\u4f7f\u7528\u7684API.\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u6240\u4ee5 API \u5c31\u662f\u7528\u6237\u770b\u5230\u7684, \u5b83\u8868\u793a\u51fa\u7528\u6237\u80fd\u4f7f\u7528\u5b83\u505a\u4ec0\u4e48. API \u7684\u5b9e\u73b0\u7ec6\u8282, \u4e5f\u5c31\u662f\u5982\u679c\u5b8c\u6210\u7684\u8be5\u529f\u80fd\u7684\u7ec6\u8282, \u9700\u8981\u5bf9\u7528\u6237\u9690\u85cf.\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u00a0<\/span><\/p>\n<h1><span data-contrast=\"none\">\u8bc6\u522b\u00a0API\u00a0\u7684\u76ee\u6807\u00a0<\/span><\/h1>\n<p><span data-contrast=\"auto\">\u8bb0\u4f4f\u9996\u5148\u8003\u8651\u7528\u6237\u7684\u611f\u53d7\u4e4b\u540e, \u4e0b\u9762\u5c31\u9700\u8981\u8003\u8651\u7528\u6237\u80fd\u62ff\u5b83\u6765\u505a\u4ec0\u4e48\u4e86, \u4e5f\u5c31\u662f\u8bc6\u522bAPI\u7684\u76ee\u6807.\u00a0\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u8bc6\u522b API \u7684\u76ee\u6807, \u6700\u57fa\u672c\u7684\u8981\u5bf9\u4ee5\u4e0b\u65b9\u9762\u6709\u6df1\u523b, \u7cbe\u51c6\u7684\u8ba4\u8bc6:\u00a0<\/span><\/p>\n<ol>\n<li data-aria-posinset=\"1\" data-aria-level=\"2\"><span data-contrast=\"auto\">Who, \u8c01\u53ef\u4ee5\u4f7f\u7528\u8fd9\u4e2aAPI?\u00a0<\/span><\/li>\n<li data-aria-posinset=\"2\" data-aria-level=\"2\"><span data-contrast=\"auto\">What, \u7528\u6237\u62ff\u8fd9\u4e2aAPI\u80fd\u505a\u4ec0\u4e48\u4e8b?\u00a0\u00a0<\/span><\/li>\n<li data-aria-posinset=\"3\" data-aria-level=\"2\"><span data-contrast=\"auto\">How, \u7528\u6237\u5982\u4f55\u505a\u8fd9\u4ef6\u4e8b?\u00a0<\/span><\/li>\n<li data-aria-posinset=\"4\" data-aria-level=\"2\"><span data-contrast=\"auto\">What need, \u7528\u6237\u60f3\u8981\u505a\u8fd9\u4ef6\u4e8b\u7684\u8bdd\u8fd8\u9700\u8981\u4ec0\u4e48?\u00a0<\/span><\/li>\n<li data-aria-posinset=\"5\" data-aria-level=\"2\"><span data-contrast=\"auto\">What return, \u7528\u6237\u4f1a\u5f97\u5230\u4ec0\u4e48?\u00a0<\/span><\/li>\n<\/ol>\n<p><span data-contrast=\"auto\">\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">1.\u5c31\u662f\u6307API\u7684\u7528\u6237, 4,5\u5206\u522b\u8868\u793a\u8f93\u5165\u8f93\u51fa.\u00a0\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u00a0<\/span><\/p>\n<h3><span data-contrast=\"none\">\u9488\u5bf92, 3\u89e3\u91ca\u4e00\u4e0b\u00a0<\/span><\/h3>\n<p><span data-contrast=\"auto\">\u901a\u5e38\u9488\u5bf92.What(\u7528\u6237\u62ffAPI\u80fd\u505a\u4ec0\u4e48)\u53ef\u4ee5\u5bfc\u81f4(\u5206\u89e3)\u591a\u4e2a3.How(\u591a\u4e2a\u6b65\u9aa4), \u8fd9\u6837\u7684\u8bdd\u6bcf\u4e2a\u6b65\u9aa4\u5c31\u662f\u4e00\u4e2aAPI\u7684\u76ee\u6807.\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u6bd4\u5982\u8bf4, \u7528\u6237\u60f3\u53bb\u6dd8\u5b9d\u4e70\u4e00\u4e2a\u5546\u54c1, \u90a3\u4e48\u600e\u4e48\u4e70? \u9996\u5148\u9700\u8981\u628a\u5546\u54c1\u6dfb\u52a0\u5230\u8d2d\u7269\u8f66, \u7136\u540e\u518d\u7ed3\u8d26. \u90a3\u4e48\u8fd9\u4e2aAPI\u5c31\u5e94\u8be5\u6709\u4e24\u4e2a\u76ee\u6807: \u6dfb\u52a0\u5546\u54c1\u5230\u8d2d\u7269\u8f66, \u4ee5\u53ca \u7ed3\u8d26.\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u5982\u679c\u4e0d\u8fd9\u6837\u5206\u89e3\u5230\u8bdd, \u901a\u5e38\u8bbe\u8ba1\u51fa\u7684API\u4f1a\u7f3a\u5931\u4e00\u4e9b\u76ee\u6807.\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u00a0<\/span><\/p>\n<h3><span data-contrast=\"none\">\u9488\u5bf91,\u00a0\u4e5f\u89e3\u91ca\u4e00\u4e0b\u00a0<\/span><\/h3>\n<p><span data-contrast=\"auto\">\u9996\u5148\u5e94\u8be5\u8bc6\u522b\u51fa\u4e0d\u540c\u79cd\u7c7b\u7684\u7528\u6237, \u8fd9\u91cc\u7684\u7528\u6237\u53ef\u80fd\u662f\u4eba, \u4e5f\u53ef\u80fd\u662f\u5176\u4ed6\u7684\u7a0b\u5e8f. \u901a\u5e38\u901a\u8fc7\u68c0\u67e5\u8f93\u5165\u548c\u8f93\u51fa\u5c31\u53ef\u4ee5\u8bc6\u522b\u51fa\u7528\u6237.\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u603b\u7ed3\u4e00\u4e0b\u5c316\u4e2a\u65b9\u9762:\u00a0<\/span><\/p>\n<ul>\n<li data-aria-posinset=\"1\" data-aria-level=\"2\"><span data-contrast=\"auto\">\u7528\u6237\u00a0<\/span><\/li>\n<li data-aria-posinset=\"2\" data-aria-level=\"2\"><span data-contrast=\"auto\">\u80fd\u505a\u4ec0\u4e48\u00a0<\/span><\/li>\n<li data-aria-posinset=\"3\" data-aria-level=\"2\"><span data-contrast=\"auto\">\u5982\u4f55\u505a &#8211; \u5206\u89e3\u6b65\u9aa4\u00a0<\/span><\/li>\n<li data-aria-posinset=\"4\" data-aria-level=\"2\"><span data-contrast=\"auto\">\u8f93\u5165\u00a0<\/span><\/li>\n<li data-aria-posinset=\"5\" data-aria-level=\"2\"><span data-contrast=\"auto\">\u8f93\u51fa\u00a0<\/span><\/li>\n<li data-aria-posinset=\"6\" data-aria-level=\"2\"><span data-contrast=\"auto\">\u76ee\u6807\u00a0<\/span><\/li>\n<\/ul>\n<p><span data-contrast=\"auto\">\u00a0<\/span><\/p>\n<h1><span data-contrast=\"none\">\u907f\u514d\u4ece\u5f00\u53d1\u8005\u89d2\u5ea6\u8bbe\u8ba1API\u00a0<\/span><\/h1>\n<p><span data-contrast=\"auto\">\u8fd9\u90e8\u5206\u5305\u542b\u51e0\u4e2a\u65b9\u9762. \u5305\u62ec:\u00a0<\/span><\/p>\n<ul>\n<li data-aria-posinset=\"1\" data-aria-level=\"2\"><span data-contrast=\"auto\">\u5f00\u53d1\u8005\u6240\u5728\u516c\u53f8\u7684\u7ec4\u7ec7\u7ed3\u6784(\u53c2\u8003\u5eb7\u5a01\u5b9a\u5f8b)\u00a0<\/span><\/li>\n<li data-aria-posinset=\"2\" data-aria-level=\"2\"><span data-contrast=\"auto\">\u6570\u636e, \u4f8b\u5982\u6570\u636e\u4f7f\u7528\u4e86\u5f00\u53d1\u8005\u6240\u5728\u516c\u53f8\u5185\u90e8\u7684\u4e00\u4e9b\u4e13\u6709\u672f\u8bed, \u6216\u8005\u5e72\u8106\u628a\u5185\u90e8\u6570\u636e\u5e93\u6a21\u578b\u66b4\u9732\u4e86\u51fa\u6765.\u00a0<\/span><\/li>\n<li data-aria-posinset=\"3\" data-aria-level=\"2\"><span data-contrast=\"auto\">\u4e0d\u8981\u66b4\u9732\u5b9e\u73b0\u7ec6\u8282, \u907f\u514d\u53d7\u5230\u4e1a\u52a1\u903b\u8f91\u5b9e\u73b0\u7ec6\u8282\u7684\u5f71\u54cd\u00a0<\/span><\/li>\n<li data-aria-posinset=\"4\" data-aria-level=\"2\"><span data-contrast=\"auto\">\u907f\u514d\u53d7\u5230\u8f6f\u4ef6\u67b6\u6784\u7684\u5f71\u54cd, \u6bd4\u5982\u8bf4\u5728\u5f00\u53d1\u8005\u516c\u53f8\u5185\u90e8\u67e5\u8be2\u4ea7\u54c1\u540d\u79f0\u548c\u4ea7\u54c1\u4ef7\u683c\u662f\u4e24\u4e2aAPI, \u90a3\u4e48\u7ed9\u7528\u6237\u4f7f\u7528\u7684API\u5fc5\u987b\u6574\u5408\u4e00\u4e0b, \u4e0d\u80fd\u8ba9\u7528\u6237\u5206\u4e24\u6b65\u67e5\u8be2.\u00a0<\/span><\/li>\n<\/ul>\n<p><span data-contrast=\"auto\">\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u6700\u91cd\u8981\u7684\u8fd8\u662f\u8981\u65f6\u523b\u7262\u8bb0, \u4f60\u6240\u8bbe\u8ba1\u7684\u8fd9\u4e9b\u4e1c\u897f\u90fd\u662f\u7528\u6237\u771f\u6b63\u9700\u8981\u7684\u5417?\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u4e0b\u9762\u5207\u5165\u6b63\u9898:\u00a0<\/span><\/p>\n<h1><span data-contrast=\"none\">\u4f7f\u7528API\u63cf\u8ff0\u683c\u5f0f\u6765\u63cf\u8ff0API\u00a0<\/span><\/h1>\n<p><span data-contrast=\"auto\">\u8fd9\u91cc\u6211\u4ee5RESTful\u98ce\u683c\u7684API\u4e3a\u4f8b. \u60f3\u8981\u4e86\u89e3\u4f7f\u7528ASP.NET Core 3.x \u6784\u5efa RESTful API, \u8fd9\u91cc\u6709\u4e00\u4e2a\u6559\u7a0b(\u4f46\u662f\u8fd8\u6ca1\u8bb2\u5b8c)\u00a0<a href=\"https:\/\/www.bilibili.com\/video\/av77957694\/\">https:\/\/www.bilibili.com\/video\/av77957694\/<\/a>.\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u5f88\u591a\u4eba\u4f7f\u7528Excel\u6216\u8005\u7eb8\u548c\u7b14\u6765\u8fdb\u884cAPI\u7684\u8bbe\u8ba1\u5de5\u4f5c. \u4f46\u662f\u5982\u679c\u60f3\u8981\u5728\u8bbe\u8ba1\u9636\u6bb5\u7cbe\u51c6\u63cf\u8ff0\u4e00\u4e2aAPI, \u5c24\u5176\u662f\u5b83\u7684\u6570\u636e, \u90a3\u4e48\u6700\u597d\u4f7f\u7528\u4e00\u4e2a\u7ed3\u6784\u5316\u7684\u5de5\u5177, \u4f8b\u5982API\u63cf\u8ff0\u683c\u5f0f.\u00a0\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">API\u63cf\u8ff0\u683c\u5f0f\u4f1a\u4e3aAPI\u63d0\u4f9b\u4e00\u4e2a\u6807\u51c6\u5316\u7684\u63cf\u8ff0, \u5e76\u4e14\u5b83\u5f88\u50cf\u4ee3\u7801. \u5b83\u7684\u4f18\u52bf\u4e3b\u8981\u6709:\u00a0<\/span><\/p>\n<ul>\n<li data-aria-posinset=\"1\" data-aria-level=\"2\"><span data-contrast=\"auto\">\u6709\u52a9\u4e8e\u5728\u9879\u76ee\u56e2\u961f\u4e2d\u5171\u4eab\u8bbe\u8ba1\u00a0<\/span><\/li>\n<li data-aria-posinset=\"2\" data-aria-level=\"2\"><span data-contrast=\"auto\">\u4e86\u89e3\u8fd9\u79cd\u683c\u5f0f\u7684\u4eba\u6216\u8005\u5de5\u5177\u53ef\u4ee5\u5f88\u7b80\u5355\u7684\u7406\u89e3\u5b83.\u00a0<\/span><\/li>\n<\/ul>\n<p><span data-contrast=\"auto\">\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u9488\u5bf9REST\u800c\u8a00, OpenAPI Specification(OAS) \u5c31\u662f\u4e00\u4e2a\u975e\u5e38\u6d41\u884cAPI\u63cf\u8ff0\u683c\u5f0f\u89c4\u8303.\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u00a0<\/span><\/p>\n<h2><span data-contrast=\"none\">OAS\u00a0<\/span><\/h2>\n<p><span data-contrast=\"auto\">API\u63cf\u8ff0\u683c\u5f0f\u662f\u4e00\u79cd\u6570\u636e\u683c\u5f0f, \u5b83\u7684\u76ee\u6807\u5c31\u662f\u63cf\u8ff0API.\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u800cOAS (OpenAPI Specification)\u662f\u4e00\u4e2a\u4e0e\u7f16\u7a0b\u8bed\u8a00\u65e0\u5173\u7684REST API\u63cf\u8ff0\u683c\u5f0f. \u5b83\u662f\u7531 OAI (OpenAPI Initiative) \u6240\u63d0\u5021\u7684. OAI \u662fLinux\u57fa\u91d1\u4f1a\u4e0b\u9762\u7684\u4e00\u4e2a\u7ec4\u7ec7, \u4e13\u6ce8\u4e8e\u63d0\u4f9b\u4e0e\u4f9b\u5e94\u5546\u65e0\u5173\u7684\u63cf\u8ff0\u683c\u5f0f. \u800cOAS\u5219\u662f\u793e\u533a\u9a71\u52a8\u7684\u4e00\u79cd\u683c\u5f0f, \u4efb\u4f55\u4eba\u90fd\u53ef\u4ee5\u505a\u8d21\u732e.\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u00a0<\/span><\/p>\n<h2><span data-contrast=\"none\">OAS vs Swagger\u00a0<\/span><\/h2>\n<p><span data-contrast=\"auto\">OAS \u539f\u6765\u53eb Swagger Specification, 2015\u5e7411\u6708\u8fd9\u4e2a\u683c\u5f0f\u88ab\u8d21\u732e\u7ed9\u4e86OAI, \u5e76\u57282016\u5e741\u6708\u66f4\u540d\u4e3a OpenAPI Specification. Swagger \u89c4\u8303\u6700\u540e\u76842.0\u7248\u672c\u5c31\u53d8\u6210\u4e86 OpenAPI 2.0. \u76ee\u524d\u6700\u65b0\u7684OAS \u5e94\u8be5\u662f3.0\u5927\u7248\u672c\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u00a0<\/span><\/p>\n<h2><span data-contrast=\"none\">YAML\u00a0<\/span><\/h2>\n<p><span data-contrast=\"auto\">OAS\u6587\u6863\u53ef\u4ee5\u4f7f\u7528YAML\u6216JSON\u683c\u5f0f, \u6211\u4f7f\u7528YAML.\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u00a0<\/span><\/p>\n<h2><span data-contrast=\"none\">\u50cf\u5199\u4ee3\u7801\u4e00\u6837\u63cf\u8ff0API\u00a0<\/span><\/h2>\n<p><span data-contrast=\"auto\">OAS\u6587\u6863\u5c31\u662f\u4e00\u4e2a\u6587\u672c\u6587\u4ef6, \u53ef\u4ee5\u7eb3\u5165\u7248\u672c\u63a7\u5236\u7cfb\u7edf ,\u4f8b\u5982 Git\u7b49. \u6240\u4ee5\u5728\u8bbe\u8ba1\u8fed\u4ee3\u7684\u65f6\u5019\u5f88\u5bb9\u6613\u8fdb\u884c\u7248\u672c\u7ba1\u7406\u548c\u53d8\u5316\u8ffd\u8e2a.\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u00a0<\/span><\/p>\n<h2><span data-contrast=\"none\">\u7f16\u8f91\u5668\u00a0<\/span><\/h2>\n<p><span data-contrast=\"auto\">OAS\u6709\u4e00\u4e2a\u5728\u7ebf\u7684\u4e13\u7528\u7f16\u8f91\u5668:\u00a0<a href=\"http:\/\/editor.swagger.io\/\">http:\/\/editor.swagger.io\/<\/a>\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u5de6\u8fb9\u662f\u4ee3\u7801\u7f16\u8f91\u533a\u57df, \u53f3\u8fb9\u662f\u6e32\u67d3\u7ed3\u679c.\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u4f46\u662f\u6211\u66f4\u4e60\u60ef\u4e8e\u672c\u5730\u7f16\u8f91\u5668, \u6211\u4f7f\u7528VSCode, \u5e76\u5b89\u88c5 Swagger Viewer \u548c openapi-lint \u4e24\u4e2a\u63d2\u4ef6.\u00a0<\/span><\/p>\n<p>{ } paths &gt; (products &gt; { } Swagger Preview &#8211; \/Users\/solenovex\/OAS\/one.yaml post &gt; { } responses &gt; { } or 200 &gt; &#8211; \/Users\/solenovex\/OAS&#8230; 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 openapi: 3. \u00f8.\u00f8 info: title: &#8220;Shopping API&#8221; version : &#8220;l.\u00f8.\u00f8\u2022\u2022 paths: \/products: description: The products catalog get: summary: Sea rch for products description: I Search for products in catalog using a free query parameter parameters: \u2014 name: free\u2014query description: I A product &#8216;s name, reference, partial description in: query required: false schema : type: string responses: description: I desc Swagger SMARTBEAR Shopping API default I.o.o OAS3 GET POST \/products Search for products \/ products Add P roduct Products matching free query parameter content: application\/json: schema : type: array description: Array of products items : type: object description: A product required: reference \u2014 name &#8221; style=&#8221;margin: 0px; padding: 0px; border: none; max-width: 800px; height: auto; cursor: zoom-in; transition: transform 0.3s cubic-bezier(0.2, 0, 0.2, 1) 0s !important;&#8221;&gt;<\/p>\n<p><span data-contrast=\"auto\">\u00a0<\/span><\/p>\n<h2><span data-contrast=\"none\">\u5171\u4eabAPI\u63cf\u8ff0,\u00a0\u5bf9API\u8fdb\u884c\u6587\u6863\u8bb0\u5f55\u00a0<\/span><\/h2>\n<p><span data-contrast=\"auto\">OAS\u6587\u6863\u53ef\u4ee5\u7528\u6765\u751f\u6210API\u5bf9\u5f15\u7528\u6587\u6863, \u8fd9\u4e2a\u5f15\u7528\u6587\u6863\u53ef\u4ee5\u5c55\u793a\u51fa\u6240\u6709\u53ef\u7528\u7684\u8d44\u6e90\u4ee5\u53ca\u76f8\u5e94\u7684\u64cd\u4f5c. \u901a\u5e38\u6211\u4f1a\u4f7f\u7528Swagger UI, \u5b83\u5c31\u662f\u4e0a\u56fe\u53f3\u4fa7\u7684\u90e8\u5206.\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u00a0<\/span><\/p>\n<h2><span data-contrast=\"none\">\u751f\u6210\u4ee3\u7801\u00a0<\/span><\/h2>\n<p><span data-contrast=\"auto\">\u4f7f\u7528API\u63cf\u8ff0\u683c\u5f0f\u8fdb\u884c\u63cf\u8ff0\u7684API, \u5176\u4ee3\u7801\u4e5f\u53ef\u4ee5\u90e8\u5206\u751f\u6210. \u901a\u5e38\u662f\u4e00\u4e2a\u4ee3\u7801\u9aa8\u67b6.\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u00a0<\/span><\/p>\n<h2><span data-contrast=\"none\">\u4ec0\u4e48\u65f6\u5019\u4f7f\u7528API\u63cf\u8ff0\u683c\u5f0f\u00a0<\/span><\/h2>\n<p><span data-contrast=\"auto\">\u80af\u5b9a\u662f\u5728\u8bbe\u8ba1\u63a5\u53e3\u5982\u4f55\u8868\u8fbeAPI\u76ee\u6807\u548c\u6982\u5ff5, \u4ee5\u53ca\u6570\u636e\u7684\u65f6\u5019.\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u00a0<\/span><\/p>\n<h1><span data-contrast=\"none\">\u4f7f\u7528OAS\u6765\u63cf\u8ff0REST API\u7684\u8d44\u6e90\u4ee5\u53caAction\u00a0<\/span><\/h1>\n<h2><span data-contrast=\"none\">\u521b\u5efaOAS\u6587\u6863\u00a0<\/span><\/h2>\n<p><span data-contrast=\"auto\">\u5efa\u7acb\u4e00\u4e2aproducts.yaml\u6587\u4ef6.\u00a0\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u7136\u540e\u5728\u91cc\u9762\u8f93\u5165 api \u6216 open\u7b49\u5b57\u7b26\u4e32, \u4f1a\u51fa\u73b0\u4e24\u4e2a\u63d0\u793a\u9009\u9879:\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u5148\u9009\u62e9\u4e0b\u9762\u90a3\u4e2a\u9009\u9879, \u5176\u7ed3\u679c\u662f:\u00a0<\/span><\/p>\n<p>{ } paths 1 2 3 4 5 openapi: 3.\u00f8.\u00f8 info: title: &#8220;API&#8221; versxon 1 paths: &#8221; width=&#8221;251&#8243; height=&#8221;141&#8243; style=&#8221;margin: 0px; padding: 0px; border: none; max-width: 800px; height: auto; cursor: zoom-in; transition: transform 0.3s cubic-bezier(0.2, 0, 0.2, 1) 0s !important;&#8221;&gt;<\/p>\n<ul>\n<li data-aria-posinset=\"1\" data-aria-level=\"2\"><span data-contrast=\"auto\">\u7b2c1\u884c\u662fOpen API\u7684\u7248\u672c\u00a0<\/span><\/li>\n<li data-aria-posinset=\"2\" data-aria-level=\"2\"><span data-contrast=\"auto\">\u7b2c4\u884c info \u7684 version \u662f\u6307API\u7684\u7248\u672c, \u800cinfo\u8fd9\u4e2a\u7248\u672c\u5fc5\u987b\u4f7f\u7528\u53cc\u5f15\u53f7\u62ec\u8d77\u6765, \u5426\u5219OAS\u89e3\u6790\u5668\u4f1a\u628a\u5b83\u5f53\u6210\u6570\u5b57, \u4ece\u800c\u5bfc\u81f4\u6587\u6863\u9a8c\u8bc1\u5931\u8d25(\u56e0\u4e3a\u5b83\u7684\u7c7b\u578b\u5e94\u8be5\u662f\u5b57\u7b26\u4e32).\u00a0<\/span><\/li>\n<li data-aria-posinset=\"3\" data-aria-level=\"2\"><span data-contrast=\"auto\">\u7b2c5\u884c paths, paths\u5c5e\u6027\u5e94\u8be5\u5305\u542b\u8be5API\u53ef\u7528\u7684\u8d44\u6e90. \u8fd9\u91cc\u9762\u4f7f\u7528 {} \u4ec5\u4ec5\u662f\u4e3a\u4e86\u8ba9\u6587\u6863\u9a8c\u8bc1\u901a\u8fc7, \u56e0\u4e3a\u6211\u76ee\u524d\u8fd8\u6ca1\u6709\u5199\u4ec0\u4e48\u5185\u5bb9. \u5728YAML\u91cc, {} \u8868\u793a\u4e00\u4e2a\u7a7a\u7684\u5bf9\u8c61, \u800c\u975e\u7a7a\u7684\u5bf9\u8c61\u5219\u4e0d\u9700\u8981\u8fd9\u5bf9\u5927\u62ec\u53f7.\u00a0<\/span><\/li>\n<\/ul>\n<p><span data-contrast=\"auto\">\u00a0<\/span><\/p>\n<h1><span data-contrast=\"none\">\u63cf\u8ff0\u8d44\u6e90\u00a0<\/span><\/h1>\n<p><span data-contrast=\"auto\">\u4e3a\u4e86\u63cf\u8ff0products\u8fd9\u4e2a\u8d44\u6e90, \u5c31\u9700\u8981\u586b\u5199paths\u5c5e\u6027:\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u8fd9\u91ccdescription\u5c5e\u6027\u4e0d\u662f\u5f3a\u5236\u7684, \u4f46\u662f\u5b83\u53ef\u4ee5\u7528\u6765\u63cf\u8ff0\u8be5\u8d44\u6e90.\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u00a0<\/span><\/p>\n<h2><span data-contrast=\"none\">\u63cf\u8ff0\u8d44\u6e90\u7684\u64cd\u4f5c\u00a0<\/span><\/h2>\n<p><span data-contrast=\"auto\">OAS\u6587\u6863\u91cc\u63cf\u8ff0\u7684\u8d44\u6e90\u80af\u5b9a\u5305\u542b\u4e00\u4e9b\u64cd\u4f5c, \u5426\u5219\u6587\u6863\u5c31\u4e0d\u5408\u7406.\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u770b\u4ee3\u7801:\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u6211\u4e3a\/products\u8fd9\u4e2a\u8d44\u6e90\u6dfb\u52a0\u4e86\u4e00\u4e2aGET Action (get\u5c5e\u6027), \u7136\u540e\u6211\u5bf9\u8fd9\u4e2aget\u4e5f\u8fdb\u884c\u4e86\u63cf\u8ff0.\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">summary\u76f8\u5f53\u4e8e\u662f\u5bf9\u8fd9\u4e2aAction\u7684\u4e00\u4e2a\u6982\u62ec\u6027\u63cf\u8ff0, \u800cdescription\u5219\u80fd\u63d0\u4f9b\u66f4\u8be6\u7ec6\u7684\u63cf\u8ff0\u4fe1\u606f.\u00a0\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u8fd9\u91ccdescription\u662f\u652f\u6301\u591a\u884c\u6587\u672c\u7684, \u4f46\u662f\u5728YAML\u91cc\u9762\u8981\u60f3\u652f\u6301\u591a\u884c\u6587\u672c, \u90a3\u4e48string\u5c5e\u6027\u5fc5\u987b\u4ee5 | \u7ba1\u9053\u7b26 \u5f00\u5934.\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u6ce8\u610f, \u8fd9\u91cc\u7b2c1\u884c openapi\u4e0b\u9762\u7684\u6ce2\u6d6a\u7ebf\u8868\u793a\u6587\u6863\u9a8c\u8bc1\u5931\u8d25.\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u5728OAS\u6587\u6863\u91cc, \u4e00\u4e2a\u64cd\u4f5c\u5fc5\u987b\u5728responses\u5c5e\u6027\u91cc\u63d0\u4f9b\u81f3\u5c11\u4e00\u4e2a\u54cd\u5e94:\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u4e00\u4e2aAction\u53ef\u80fd\u6709\u591a\u79cd\u54cd\u5e94\u7ed3\u679c, \u6bcf\u79cd\u53ef\u80fd\u7684\u54cd\u5e94\u7ed3\u679c\u90fd\u8981\u5728responses\u5c5e\u6027\u4e2d\u63cf\u8ff0.\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u6bcf\u4e2a\u54cd\u5e94\u90fd\u4ee5\u72b6\u6001\u7801\u8fdb\u884c\u6807\u8bc6, \u5e76\u4e14\u5fc5\u987b\u5305\u542b\u4e00\u4e2adescription\u5c5e\u6027.\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u6ce8\u610f: \u72b6\u6001\u7801\u6570\u5b57\u5fc5\u987b\u7528\u53cc\u5f15\u53f7\u62ec\u8d77\u6765, \u56e0\u4e3a\u5b83\u7684\u7c7b\u578b\u672c\u5e94\u8be5\u662f\u5b57\u7b26\u4e32, \u800c\u8fd9\u91cc\u7684200\u662f\u4e00\u4e2a\u6570\u5b57.\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u4e0b\u9762\u6211\u518d\u6dfb\u52a0\u4e00\u4e2aPOST Action:\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u8fd9\u91cc\u8fd8\u662f\u9488\u5bf9 \/products \u8fd9\u4e2a\u8d44\u6e90, \u6211\u5c31\u4e0d\u8fc7\u591a\u89e3\u91ca\u4e86.\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u00a0<\/span><\/p>\n<h1><span data-contrast=\"none\">\u4f7f\u7528OpenAPI\u00a0\u548c\u00a0JSON Schema\u00a0\u6765\u63cf\u8ff0\u00a0API\u00a0\u7684\u6570\u636e\u00a0<\/span><\/h1>\n<p><span data-contrast=\"auto\">OAS \u4f9d\u8d56\u4e8e JSON Schema \u6807\u51c6\u6765\u5bf9\u6240\u6709\u7684\u6570\u636e(\u67e5\u8be2\u53c2\u6570, body \u53c2\u6570, \u54cd\u5e94body\u7b49)\u8fdb\u884c\u63cf\u8ff0.\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u6ce8\u610f, OAS \u4f7f\u7528\u7684\u5176\u5b9e\u662fJSON Schema\u7684\u4e00\u4e2a\u5b50\u96c6, \u5e76\u4e0d\u5305\u542b\u6240\u6709\u7684 JSON Schema \u7279\u6027, \u5e76\u4e14\u8fd8\u6dfb\u52a0\u4e86\u4e00\u4e9b OAS \u72ec\u6709\u7684\u7279\u6027\u5230\u8fd9\u4e2a\u5b50\u96c6\u91cc.<br \/>\n<\/span><\/p>\n<h2><span data-contrast=\"none\">\u63cf\u8ff0\u67e5\u8be2\u53c2\u6570\u00a0<\/span><\/h2>\n<p><span data-contrast=\"auto\">\u5982\u679c\u6211\u4eec\u7684get\u64cd\u4f5c\u91cc\u9700\u8981\u4e00\u4e9b\u67e5\u8be2\u53c2\u6570(\u67e5\u8be2\u5b57\u7b26\u4e32, Query String), \u90a3\u4e48\u53ef\u4ee5\u4f7f\u7528 parameters \u8fd9\u4e2a\u5c5e\u6027:\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u8fd9\u91cc parameters\u5c5e\u6027\u662f\u4e00\u4e2a\u96c6\u5408\u6216\u6570\u7ec4, \u6bcf\u4e2a\u96c6\u5408\u5143\u7d20\u4f7f\u7528 &#8211; \u5f00\u5934.\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u4e3a\u4e86\u63cf\u8ff0\u4e00\u4e2a\u53c2\u6570, \u81f3\u5c11\u9700\u8981name, in \u548c schema \u4e09\u4e2a\u5c5e\u6027. \u5728\u672c\u4f8b\u4e2d, \u8fd8\u5305\u542b required \u548c description \u4e24\u4e2a\u53ef\u9009\u7684\u5c5e\u6027.\u00a0<\/span><\/p>\n<ul>\n<li data-aria-posinset=\"1\" data-aria-level=\"2\"><span data-contrast=\"auto\">in\u8868\u793a\u53c2\u6570\u7684\u4f4d\u7f6e, \u8fd9\u91cc\u503c\u4e3aquery, \u8868\u8ff0\u5b83\u662f\u67e5\u8be2\u5b57\u7b26\u4e32(Query String, \u4f8b\u5982 api\/products?searchTerm=xxx).\u00a0\u00a0<\/span><\/li>\n<li data-aria-posinset=\"2\" data-aria-level=\"2\"><span data-contrast=\"auto\">required \u4e3a false \u8868\u793a\u4e0d\u662f\u5fc5\u586b\u53c2\u6570. required\u662f\u53ef\u9009\u7684, \u5982\u679c\u6ca1\u6709\u5199\u7684\u8bdd, \u90a3\u4e48\u5b83\u7684\u503c\u5c31\u662ffalse. \u4f46\u662f\u6700\u597d\u8fd8\u662f\u5199\u4e0arequired\u5c5e\u6027.\u00a0<\/span><\/li>\n<li data-aria-posinset=\"3\" data-aria-level=\"2\"><span data-contrast=\"auto\">\u5b83\u7684\u6570\u636e\u7ed3\u6784\u4f7f\u7528schema\u5c5e\u6027\u6765\u8868\u793a, \u8fd9\u91cc\u5c31\u662f\u4e00\u4e2a\u7b80\u5355\u7684\u5b57\u7b26\u4e32\u7c7b\u578b. \u4f46\u662f\u5b83\u5176\u5b9e\u662f\u4e00\u4e2aJSON schema, \u6240\u4ee5\u5b83\u53ef\u4ee5\u662f\u590d\u6742\u7684\u5bf9\u8c61\u7c7b\u578b.\u00a0<\/span><\/li>\n<li data-aria-posinset=\"4\" data-aria-level=\"2\"><span data-contrast=\"auto\">description\u5c5e\u6027\u4e5f\u662f\u53ef\u9009\u7684, \u4f46\u662f\u6700\u597d\u8fd8\u662f\u5199\u4e0a\u5427, \u6709\u4e2a\u63cf\u8ff0\u66f4\u597d.\u00a0<\/span><\/li>\n<\/ul>\n<p><span data-contrast=\"auto\">\u00a0<\/span><\/p>\n<h2><span data-contrast=\"none\">\u4f7f\u7528JSON Schema\u6765\u63cf\u8ff0\u6570\u636e\u00a0<\/span><\/h2>\n<p><span data-contrast=\"auto\">\u5047\u8bbe\u4e00\u4e2a\u5bf9\u8c61\u6709\u4e09\u4e2a\u5c5e\u6027: \u7f16\u53f7(string), \u540d\u79f0(string), \u4ef7\u683c(number). \u90a3\u4e48\u4f7f\u7528JSON Schema\u6765\u63cf\u8ff0\u5b83\u5c31\u5e94\u8be5\u662f\u8fd9\u6837\u7684:\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u8fd8\u6ca1\u5b8c, \u6211\u8fd8\u5fc5\u987b\u6307\u51fa\u5c5e\u6027\u662f\u5426\u662f\u5fc5\u586b\u7684, \u7136\u540e\u6211\u518d\u52a0\u4e0a\u4e00\u4e2aremark\u5c5e\u6027, \u5b83\u4e0d\u662f\u5fc5\u586b\u7684:\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">JSON Schema \u901a\u8fc7 required \u8fd9\u4e2a\u96c6\u5408\u5c5e\u6027\u6765\u8868\u793a\u54ea\u4e9b\u5c5e\u6027\u662f\u5fc5\u586b\u7684.\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u6b64\u5916, \u6211\u8fd8\u53ef\u4ee5\u5728\u8fd9\u91cc\u6dfb\u52a0 description \u548c example (\u793a\u4f8b)\u5c5e\u6027:\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u6b64\u5916 JSON Schema \u8fd8\u652f\u6301 \u5bf9\u8c61\u5c5e\u6027\u7c7b\u578b:\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">JSON Schema \u7684\u4e1c\u897f\u6bd4\u8f83\u591a, \u5177\u4f53\u53ef\u4ee5\u67e5\u627e\u4e00\u4e0b\u5b98\u65b9\u6587\u6863.\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u00a0<\/span><\/p>\n<h2><span data-contrast=\"none\">\u63cf\u8ff0\u54cd\u5e94\u00a0<\/span><\/h2>\n<p><span data-contrast=\"auto\">\u5728OAS\u6587\u6863\u91cc, \u64cd\u4f5c\u54cd\u5e94\u8fd4\u56de\u7684body\u91cc\u7684\u6570\u636e\u662f\u7528content\u5c5e\u6027\u6765\u8868\u793a:\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u8fd9\u91cc\u9700\u8981\u6ce8\u610f\u7684\u5c31\u662f\u8be5\u64cd\u4f5c\u7684\u7ed3\u679c\u662f\u4ea7\u54c1\u7684\u6570\u7ec4, \u6240\u4ee5\u7c7b\u578b\u662farray, \u800carray \u7684 items\u5c5e\u6027\u5c31\u5305\u542b\u7740\u6570\u7ec4\u5143\u7d20\u7684schema.\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u00a0<\/span><\/p>\n<h2><span data-contrast=\"none\">\u63cf\u8ff0\u00a0body\u00a0\u53c2\u6570\u00a0<\/span><\/h2>\n<p><span data-contrast=\"auto\">\u50cf POST \u8fd9\u6837\u7684 Action, \u5b83\u7684\u53c2\u6570\u662f\u5728\u8bf7\u6c42\u7684body\u91cc\u9762.\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">body\u53c2\u6570\u9700\u8981\u4f7f\u7528 requestBody\u5c5e\u6027\u63cf\u8ff0, \u770b\u4ee3\u7801:\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u8fd9\u4e2a body \u53c2\u6570\u7684\u5185\u5bb9\u4e5f\u662f\u4f7f\u7528 JSON Schema\u6765\u63cf\u8ff0\u7684.\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u00a0<\/span><\/p>\n<h2><span data-contrast=\"none\">\u63cf\u8ff0\u8def\u7531\u53c2\u6570\u00a0<\/span><\/h2>\n<p><span data-contrast=\"auto\">\u50cf api\/products\/{productId} \u8fd9\u6837\u7684URI\u91cc, productId\u5c31\u662f\u4e00\u4e2a\u8def\u7531\/\u8def\u5f84\u53c2\u6570.\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u5b83\u53ef\u4ee5\u8fd9\u6837\u63cf\u8ff0:\u00a0<\/span><\/p>\n<p>paths : \/products: \/products\/{p roductld}: description: delete: summary: parameters: &#8211; name: productld in: path required: true description: FhfiID schema: type: string components: &#8221; width=&#8221;414&#8243; height=&#8221;322&#8243; style=&#8221;margin: 0px; padding: 0px; border: none; max-width: 800px; height: auto; cursor: zoom-in; transition: transform 0.3s cubic-bezier(0.2, 0, 0.2, 1) 0s !important;&#8221;&gt;<\/p>\n<p><span data-contrast=\"auto\">\u8fd9\u91cc\u9762name\u7684\u503c\u5fc5\u987b\u548c {} \u91cc\u9762\u7684\u503c\u4e00\u6837.\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">in \u7684\u503c\u4e3a path, \u8868\u793a\u662f\u8def\u5f84\u53c2\u6570.\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u8def\u5f84\u53c2\u6570\u662f\u5fc5\u586b\u7684, \u6240\u4ee5 required \u4e3a true. \u4e0d\u7136\u89e3\u6790\u5668\u4f1a\u62a5\u9519.\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u00a0<\/span><\/p>\n<h1><span data-contrast=\"none\">\u53ef\u590d\u7528\u7ec4\u4ef6\u00a0<\/span><\/h1>\n<p><span data-contrast=\"auto\">OAS\u5141\u8bb8\u4f7f\u7528\u53ef\u590d\u7528\u7684\u7ec4\u4ef6, \u4f8b\u5982 schema, \u53c2\u6570, \u54cd\u5e94\u7b49\u7b49, \u4f7f\u7528\u5b83\u4eec\u7684\u65f6\u5019\u6dfb\u52a0\u4e2a\u5f15\u7528\u5c31\u884c.\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u5047\u8bbe\u9488\u5bf9 \/products \u8fd9\u4e2a\u8d44\u6e90\u4e00\u5171\u6709\u4e24\u4e2a\u64cd\u4f5c: \u4e00\u4e2a\u662f\u8fd4\u56de\u4e00\u7ec4\u4ea7\u54c1, \u53e6\u4e00\u4e2a\u8fd4\u56de\u5355\u4e2a\u4ea7\u54c1. \u8fd9\u65f6\u5019\u8fd4\u56de\u4ea7\u54c1\u7684JSON Schema\u5c31\u53ef\u4ee5\u4f7f\u7528\u4e00\u4e2a\u53ef\u590d\u7528\u7684schema.\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u53ef\u590d\u7528\u7684\u7ec4\u4ef6\u8981\u653e\u5728components\u533a\u57df, \u5b83\u662fOAS\u6587\u6863\u7684\u4e00\u4e2a\u6839\u7ea7\u5c5e\u6027. \u770b\u4f8b\u5b50:\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u8fd9\u91cc\u9762, \u53ef\u590d\u7528\u7684schema\u88ab\u5b9a\u4e49\u5728schemas\u5c5e\u6027\u91cc, \u6bcf\u4e2a\u53ef\u91cd\u7528\u7684schema\u7684\u540d\u5b57\u5c31\u662fschemas\u7684\u503c, \u8fd9\u91cc\u5c31\u662fproduct. \u5b83\u4e0b\u5c31\u5305\u542b\u7740\u53ef\u91cd\u7528\u7684\u7ec4\u4ef6: \u4e00\u4e2a JSON Schema.\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u00a0<\/span><\/p>\n<h2><span data-contrast=\"none\">\u5f15\u7528\u5b9a\u4e49\u597d\u7684schema\u00a0<\/span><\/h2>\n<p><span data-contrast=\"auto\">\u5f15\u7528\u5b9a\u4e49\u597d\u7684schema\u9700\u8981\u4f7f\u7528\u5230JSON\u5f15\u7528. JSON\u5f15\u7528\u8fd9\u4e2a\u5c5e\u6027\u7684\u540d\u5b57\u662f$ref, \u5b83\u7684\u503c\u662f\u4e00\u4e2aURL. \u8fd9\u4e2aURL\u53ef\u6307\u5411\u672c\u6587\u6863\u5185\u90e8\u751a\u81f3\u5916\u90e8\u7684\u7ec4\u4ef6. \u8fd9\u91cc\u6211\u53ea\u5f15\u7528\u6587\u6863\u5185\u90e8\u7684\u7ec4\u4ef6.\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u800c\u9488\u5bf9\u90a3\u4e2a get Action\u7684\u8fd4\u56de\u7ed3\u679c(\u6570\u7ec4\u7c7b\u578b), \u9700\u8981\u628aJSON\u5f15\u7528\u653e\u5728 array \u7684 items\u5c5e\u6027\u91cc.\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u00a0<\/span><\/p>\n<h2><span data-contrast=\"none\">\u53ef\u590d\u7528\u53c2\u6570\u00a0<\/span><\/h2>\n<p><span data-contrast=\"auto\">\u76f4\u63a5\u770b\u4ee3\u7801:\u00a0<\/span><\/p>\n<p>schemas: parameters: productld: name: productld in: path required: true description: F%ID schema : type: string &#8221; width=&#8221;587&#8243; height=&#8221;336&#8243; style=&#8221;margin: 0px; padding: 0px; border: none; max-width: 800px; height: auto; cursor: zoom-in; transition: transform 0.3s cubic-bezier(0.2, 0, 0.2, 1) 0s !important;&#8221;&gt;<\/p>\n<p><span data-contrast=\"auto\">\u548c\u53ef\u590d\u7528schema\u7c7b\u4f3c, \u53ef\u590d\u7528\u53c2\u6570\u4e5f\u653e\u5728components\u4e0b\u9762, \u5b83\u6240\u5728\u7684\u533a\u57df\u662f parameters. \u5176\u5f15\u7528\u65b9\u5f0f\u4e5f\u7c7b\u4f3c, \u5c31\u4e0d\u8fc7\u591a\u4ecb\u7ecd\u4e86.\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u9664\u4e86\u5728Action\u7ea7\u522b\u5f15\u7528\u53ef\u590d\u7528\u53c2\u6570, \u5728\u8d44\u6e90\u8fd9\u4e2a\u7ea7\u522b\u4e5f\u53ef\u4ee5\u8fd9\u6837\u505a:\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">\u00a0<\/span><\/p>\n<h2><span data-contrast=\"none\">\u9884\u89c8\u00a0<\/span><\/h2>\n<p><span data-contrast=\"auto\">\u00a0<\/span><\/p>\n","protected":false},"excerpt":{"rendered":"<p>\u539f\u6587\u5730\u5740 &nbsp; \u65e0\u8bba\u54ea\u79cd\u7c7b\u578b\u7684W<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"colormag_page_container_layout":"default_layout","colormag_page_sidebar_layout":"default_layout","footnotes":""},"categories":[24],"tags":[121],"class_list":["post-5799","post","type-post","status-publish","format-standard","hentry","category-value_docs","tag-05-"],"_links":{"self":[{"href":"https:\/\/i007.cc\/wordpress\/wp-json\/wp\/v2\/posts\/5799","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/i007.cc\/wordpress\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/i007.cc\/wordpress\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/i007.cc\/wordpress\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/i007.cc\/wordpress\/wp-json\/wp\/v2\/comments?post=5799"}],"version-history":[{"count":0,"href":"https:\/\/i007.cc\/wordpress\/wp-json\/wp\/v2\/posts\/5799\/revisions"}],"wp:attachment":[{"href":"https:\/\/i007.cc\/wordpress\/wp-json\/wp\/v2\/media?parent=5799"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/i007.cc\/wordpress\/wp-json\/wp\/v2\/categories?post=5799"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/i007.cc\/wordpress\/wp-json\/wp\/v2\/tags?post=5799"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}