{"id":5863,"date":"2022-06-02T23:53:49","date_gmt":"2022-06-02T15:53:49","guid":{"rendered":"https:\/\/damogame.cn:15443\/wordpress\/?p=5863"},"modified":"2022-06-02T23:53:49","modified_gmt":"2022-06-02T15:53:49","slug":"swagger%e4%bb%8b%e7%bb%8d%e5%8f%8a%e4%bd%bf%e7%94%a8","status":"publish","type":"post","link":"https:\/\/i007.cc\/wordpress\/archives\/5863","title":{"rendered":"Swagger\u4ecb\u7ecd\u53ca\u4f7f\u7528"},"content":{"rendered":"<p class=\"_1RuRku\"><a href=\"https:\/\/www.jianshu.com\/p\/349e130e40d5\">\u539f\u6587\u5730\u5740<\/a><\/p>\n<div class=\"rEsl9f\">\n<div class=\"_2mYfmT\"><a class=\"_1qp91i _1OhGeD\" href=\"https:\/\/www.jianshu.com\/u\/199d841c785a\" target=\"_blank\" rel=\"noopener noreferrer\"><img decoding=\"async\" class=\"_13D2Eh\" src=\"https:\/\/upload.jianshu.io\/users\/upload_avatars\/813533\/1b54b4d08cf5.jpg?imageMogr2\/auto-orient\/strip|imageView2\/1\/w\/96\/h\/96\/format\/webp\" alt=\"\" \/><\/a><\/p>\n<div>\n<div class=\"_3U4Smb\"><span class=\"FxYr8x\"><a class=\"_1OhGeD\" href=\"https:\/\/www.jianshu.com\/u\/199d841c785a\" target=\"_blank\" rel=\"noopener noreferrer\">wuqke<\/a><\/span><button class=\"_3kba3h _1OyPqC _3Mi9q9 _34692-\" type=\"button\" data-locale=\"zh-CN\">\u5173\u6ce8<\/button><\/div>\n<div class=\"s-dsoj\"><span class=\"_3tCVn5\"><i class=\"anticon\" aria-label=\"ic-diamond\"><\/i>17<\/span><time datetime=\"2018-12-06T17:39:21.000Z\">2018.12.07 01:39:21<\/time>\u5b57\u6570 2,241\u9605\u8bfb 1,252,864<\/div>\n<\/div>\n<\/div>\n<\/div>\n<article class=\"_2rhmJa\">\n<h4>\u5bfc\u8bed\uff1a<\/h4>\n<blockquote><p>\u76f8\u4fe1\u65e0\u8bba\u662f\u524d\u7aef\u8fd8\u662f\u540e\u7aef\u5f00\u53d1\uff0c\u90fd\u6216\u591a\u6216\u5c11\u5730\u88ab\u63a5\u53e3\u6587\u6863\u6298\u78e8\u8fc7\u3002\u524d\u7aef\u7ecf\u5e38\u62b1\u6028\u540e\u7aef\u7ed9\u7684\u63a5\u53e3\u6587\u6863\u4e0e\u5b9e\u9645\u60c5\u51b5\u4e0d\u4e00\u81f4\u3002\u540e\u7aef\u53c8\u89c9\u5f97\u7f16\u5199\u53ca\u7ef4\u62a4\u63a5\u53e3\u6587\u6863\u4f1a\u8017\u8d39\u4e0d\u5c11\u7cbe\u529b\uff0c\u7ecf\u5e38\u6765\u4e0d\u53ca\u66f4\u65b0\u3002\u5176\u5b9e\u65e0\u8bba\u662f\u524d\u7aef\u8c03\u7528\u540e\u7aef\uff0c\u8fd8\u662f\u540e\u7aef\u8c03\u7528\u540e\u7aef\uff0c\u90fd\u671f\u671b\u6709\u4e00\u4e2a\u597d\u7684\u63a5\u53e3\u6587\u6863\u3002\u4f46\u662f\u8fd9\u4e2a\u63a5\u53e3\u6587\u6863\u5bf9\u4e8e\u7a0b\u5e8f\u5458\u6765\u8bf4\uff0c\u5c31\u8ddf\u6ce8\u91ca\u4e00\u6837\uff0c\u7ecf\u5e38\u4f1a\u62b1\u6028\u522b\u4eba\u5199\u7684\u4ee3\u7801\u6ca1\u6709\u5199\u6ce8\u91ca\uff0c\u7136\u800c\u81ea\u5df1\u5199\u8d77\u4ee3\u7801\u8d77\u6765\uff0c\u6700\u8ba8\u538c\u7684\uff0c\u4e5f\u662f\u5199\u6ce8\u91ca\u3002\u6240\u4ee5\u4ec5\u4ec5\u53ea\u901a\u8fc7\u5f3a\u5236\u6765\u89c4\u8303\u5927\u5bb6\u662f\u4e0d\u591f\u7684\uff0c\u968f\u7740\u65f6\u95f4\u63a8\u79fb\uff0c\u7248\u672c\u8fed\u4ee3\uff0c\u63a5\u53e3\u6587\u6863\u5f80\u5f80\u5f88\u5bb9\u6613\u5c31\u8ddf\u4e0d\u4e0a\u4ee3\u7801\u4e86\u3002<\/p><\/blockquote>\n<h2>Swagger\u662f\u4ec0\u4e48\uff1f\u5b83\u80fd\u5e72\u4ec0\u4e48\uff1f<\/h2>\n<div class=\"image-package\">\n<div class=\"image-container\">\n<div class=\"image-container-fill\"><\/div>\n<div class=\"image-view\" data-width=\"1550\" data-height=\"594\"><img decoding=\"async\" class=\"\" src=\"https:\/\/upload-images.jianshu.io\/upload_images\/813533-774318cdb25c338d.png?imageMogr2\/auto-orient\/strip|imageView2\/2\/w\/1200\/format\/webp\" data-original-src=\"\/\/upload-images.jianshu.io\/upload_images\/813533-774318cdb25c338d.png\" data-original-width=\"1550\" data-original-height=\"594\" data-original-format=\"image\/png\" data-original-filesize=\"78460\" data-image-index=\"0\" \/><\/div>\n<\/div>\n<div class=\"image-caption\">image.png<\/div>\n<\/div>\n<p>\u53d1\u73b0\u4e86\u75db\u70b9\u5c31\u8981\u53bb\u627e\u89e3\u51b3\u65b9\u6848\u3002\u89e3\u51b3\u65b9\u6848\u7528\u7684\u4eba\u591a\u4e86\uff0c\u5c31\u6210\u4e86\u6807\u51c6\u7684\u89c4\u8303\uff0c\u8fd9\u5c31\u662fSwagger\u7684\u7531\u6765\u3002\u901a\u8fc7\u8fd9\u5957\u89c4\u8303\uff0c\u4f60\u53ea\u9700\u8981\u6309\u7167\u5b83\u7684\u89c4\u8303\u53bb\u5b9a\u4e49\u63a5\u53e3\u53ca\u63a5\u53e3\u76f8\u5173\u7684\u4fe1\u606f\u3002\u518d\u901a\u8fc7Swagger\u884d\u751f\u51fa\u6765\u7684\u4e00\u7cfb\u5217\u9879\u76ee\u548c\u5de5\u5177\uff0c\u5c31\u53ef\u4ee5\u505a\u5230\u751f\u6210\u5404\u79cd\u683c\u5f0f\u7684\u63a5\u53e3\u6587\u6863\uff0c\u751f\u6210\u591a\u79cd\u8bed\u8a00\u7684\u5ba2\u6237\u7aef\u548c\u670d\u52a1\u7aef\u7684\u4ee3\u7801\uff0c\u4ee5\u53ca\u5728\u7ebf\u63a5\u53e3\u8c03\u8bd5\u9875\u9762\u7b49\u7b49\u3002\u8fd9\u6837\uff0c\u5982\u679c\u6309\u7167\u65b0\u7684\u5f00\u53d1\u6a21\u5f0f\uff0c\u5728\u5f00\u53d1\u65b0\u7248\u672c\u6216\u8005\u8fed\u4ee3\u7248\u672c\u7684\u65f6\u5019\uff0c\u53ea\u9700\u8981\u66f4\u65b0Swagger\u63cf\u8ff0\u6587\u4ef6\uff0c\u5c31\u53ef\u4ee5\u81ea\u52a8\u751f\u6210\u63a5\u53e3\u6587\u6863\u548c\u5ba2\u6237\u7aef\u670d\u52a1\u7aef\u4ee3\u7801\uff0c\u505a\u5230\u8c03\u7528\u7aef\u4ee3\u7801\u3001\u670d\u52a1\u7aef\u4ee3\u7801\u4ee5\u53ca\u63a5\u53e3\u6587\u6863\u7684\u4e00\u81f4\u6027\u3002<\/p>\n<p>\u4f46\u5373\u4fbf\u5982\u6b64\uff0c\u5bf9\u4e8e\u8bb8\u591a\u5f00\u53d1\u6765\u8bf4\uff0c\u7f16\u5199\u8fd9\u4e2ayml\u6216json\u683c\u5f0f\u7684\u63cf\u8ff0\u6587\u4ef6\uff0c\u672c\u8eab\u4e5f\u662f\u6709\u4e00\u5b9a\u8d1f\u62c5\u7684\u5de5\u4f5c\uff0c\u7279\u522b\u662f\u5728\u540e\u9762\u6301\u7eed\u8fed\u4ee3\u5f00\u53d1\u7684\u65f6\u5019\uff0c\u5f80\u5f80\u4f1a\u5ffd\u7565\u66f4\u65b0\u8fd9\u4e2a\u63cf\u8ff0\u6587\u4ef6\uff0c\u76f4\u63a5\u66f4\u6539\u4ee3\u7801\u3002\u4e45\u800c\u4e45\u4e4b\uff0c\u8fd9\u4e2a\u63cf\u8ff0\u6587\u4ef6\u4e5f\u548c\u5b9e\u9645\u9879\u76ee\u6e10\u884c\u6e10\u8fdc\uff0c\u57fa\u4e8e\u8be5\u63cf\u8ff0\u6587\u4ef6\u751f\u6210\u7684\u63a5\u53e3\u6587\u6863\u4e5f\u5931\u53bb\u4e86\u53c2\u8003\u610f\u4e49\u3002\u6240\u4ee5\u4f5c\u4e3aJava\u5c4a\u670d\u52a1\u7aef\u7684\u5927\u4e00\u7edf\u6846\u67b6Spring\uff0c\u8fc5\u901f\u5c06Swagger\u89c4\u8303\u7eb3\u5165\u81ea\u8eab\u7684\u6807\u51c6\uff0c\u5efa\u7acb\u4e86Spring-swagger\u9879\u76ee\uff0c\u540e\u9762\u6539\u6210\u4e86\u73b0\u5728\u7684Springfox\u3002\u901a\u8fc7\u5728\u9879\u76ee\u4e2d\u5f15\u5165Springfox\uff0c\u53ef\u4ee5\u626b\u63cf\u76f8\u5173\u7684\u4ee3\u7801\uff0c\u751f\u6210\u8be5\u63cf\u8ff0\u6587\u4ef6\uff0c\u8fdb\u800c\u751f\u6210\u4e0e\u4ee3\u7801\u4e00\u81f4\u7684\u63a5\u53e3\u6587\u6863\u548c\u5ba2\u6237\u7aef\u4ee3\u7801\u3002\u8fd9\u79cd\u901a\u8fc7\u4ee3\u7801\u751f\u6210\u63a5\u53e3\u6587\u6863\u7684\u5f62\u5f0f\uff0c\u5728\u540e\u9762\u9700\u6c42\u6301\u7eed\u8fed\u4ee3\u7684\u9879\u76ee\u4e2d\uff0c\u663e\u5f97\u5c24\u4e3a\u91cd\u8981\u548c\u9ad8\u6548\u3002<\/p>\n<h2>\u6846\u67b6\u8bf4\u660e\u53ca\u4f7f\u7528<\/h2>\n<h3>1.\u8bf4\u660e<\/h3>\n<p>\u73b0\u5728SWAGGER\u5b98\u7f51\u4e3b\u8981\u63d0\u4f9b\u4e86\u51e0\u79cd\u5f00\u6e90\u5de5\u5177\uff0c\u63d0\u4f9b\u76f8\u5e94\u7684\u529f\u80fd\u3002\u53ef\u4ee5\u901a\u8fc7\u914d\u7f6e\u751a\u81f3\u662f\u4fee\u6539\u6e90\u7801\u4ee5\u8fbe\u5230\u4f60\u60f3\u8981\u7684\u6548\u679c\u3002<\/p>\n<div class=\"image-package\">\n<div class=\"image-container\">\n<div class=\"image-container-fill\"><\/div>\n<div class=\"image-view\" data-width=\"1016\" data-height=\"690\"><img decoding=\"async\" class=\"\" src=\"https:\/\/upload-images.jianshu.io\/upload_images\/813533-15b9f1e097ccd777.png?imageMogr2\/auto-orient\/strip|imageView2\/2\/w\/1016\/format\/webp\" data-original-src=\"\/\/upload-images.jianshu.io\/upload_images\/813533-15b9f1e097ccd777.png\" data-original-width=\"1016\" data-original-height=\"690\" data-original-format=\"image\/png\" data-original-filesize=\"124027\" data-image-index=\"1\" \/><\/div>\n<\/div>\n<div class=\"image-caption\">image.png<\/div>\n<\/div>\n<p><strong>Swagger Codegen<\/strong>: \u901a\u8fc7Codegen \u53ef\u4ee5\u5c06\u63cf\u8ff0\u6587\u4ef6\u751f\u6210html\u683c\u5f0f\u548ccwiki\u5f62\u5f0f\u7684\u63a5\u53e3\u6587\u6863\uff0c\u540c\u65f6\u4e5f\u80fd\u751f\u6210\u591a\u949f\u8bed\u8a00\u7684\u670d\u52a1\u7aef\u548c\u5ba2\u6237\u7aef\u7684\u4ee3\u7801\u3002\u652f\u6301\u901a\u8fc7jar\u5305\uff0cdocker\uff0cnode\u7b49\u65b9\u5f0f\u5728\u672c\u5730\u5316\u6267\u884c\u751f\u6210\u3002\u4e5f\u53ef\u4ee5\u5728\u540e\u9762\u7684Swagger Editor\u4e2d\u5728\u7ebf\u751f\u6210\u3002<\/p>\n<p><strong>Swagger UI<\/strong>:\u63d0\u4f9b\u4e86\u4e00\u4e2a\u53ef\u89c6\u5316\u7684UI\u9875\u9762\u5c55\u793a\u63cf\u8ff0\u6587\u4ef6\u3002\u63a5\u53e3\u7684\u8c03\u7528\u65b9\u3001\u6d4b\u8bd5\u3001\u9879\u76ee\u7ecf\u7406\u7b49\u90fd\u53ef\u4ee5\u5728\u8be5\u9875\u9762\u4e2d\u5bf9\u76f8\u5173\u63a5\u53e3\u8fdb\u884c\u67e5\u9605\u548c\u505a\u4e00\u4e9b\u7b80\u5355\u7684\u63a5\u53e3\u8bf7\u6c42\u3002\u8be5\u9879\u76ee\u652f\u6301\u5728\u7ebf\u5bfc\u5165\u63cf\u8ff0\u6587\u4ef6\u548c\u672c\u5730\u90e8\u7f72UI\u9879\u76ee\u3002<\/p>\n<p><strong>Swagger Editor<\/strong>: \u7c7b\u4f3c\u4e8emarkendown\u7f16\u8f91\u5668\u7684\u7f16\u8f91Swagger\u63cf\u8ff0\u6587\u4ef6\u7684\u7f16\u8f91\u5668\uff0c\u8be5\u7f16\u8f91\u652f\u6301\u5b9e\u65f6\u9884\u89c8\u63cf\u8ff0\u6587\u4ef6\u7684\u66f4\u65b0\u6548\u679c\u3002\u4e5f\u63d0\u4f9b\u4e86\u5728\u7ebf\u7f16\u8f91\u5668\u548c\u672c\u5730\u90e8\u7f72\u7f16\u8f91\u5668\u4e24\u79cd\u65b9\u5f0f\u3002<\/p>\n<p><strong>Swagger Inspector<\/strong>: \u611f\u89c9\u548cpostman\u5dee\u4e0d\u591a\uff0c\u662f\u4e00\u4e2a\u53ef\u4ee5\u5bf9\u63a5\u53e3\u8fdb\u884c\u6d4b\u8bd5\u7684\u5728\u7ebf\u7248\u7684postman\u3002\u6bd4\u5728Swagger UI\u91cc\u9762\u505a\u63a5\u53e3\u8bf7\u6c42\uff0c\u4f1a\u8fd4\u56de\u66f4\u591a\u7684\u4fe1\u606f\uff0c\u4e5f\u4f1a\u4fdd\u5b58\u4f60\u8bf7\u6c42\u7684\u5b9e\u9645\u8bf7\u6c42\u53c2\u6570\u7b49\u6570\u636e\u3002<\/p>\n<p><strong>Swagger Hub<\/strong>\uff1a\u96c6\u6210\u4e86\u4e0a\u9762\u6240\u6709\u9879\u76ee\u7684\u5404\u4e2a\u529f\u80fd\uff0c\u4f60\u53ef\u4ee5\u4ee5\u9879\u76ee\u548c\u7248\u672c\u4e3a\u5355\u4f4d\uff0c\u5c06\u4f60\u7684\u63cf\u8ff0\u6587\u4ef6\u4e0a\u4f20\u5230Swagger Hub\u4e2d\u3002\u5728Swagger Hub\u4e2d\u53ef\u4ee5\u5b8c\u6210\u4e0a\u9762\u9879\u76ee\u7684\u6240\u6709\u5de5\u4f5c\uff0c\u9700\u8981\u6ce8\u518c\u8d26\u53f7\uff0c\u5206\u514d\u8d39\u7248\u548c\u6536\u8d39\u7248\u3002<\/p>\n<p>PS\uff1a<\/p>\n<p><strong>Springfox Swagger<\/strong>: Spring \u57fa\u4e8eswagger\u89c4\u8303\uff0c\u53ef\u4ee5\u5c06\u57fa\u4e8eSpringMVC\u548cSpring Boot\u9879\u76ee\u7684\u9879\u76ee\u4ee3\u7801\uff0c\u81ea\u52a8\u751f\u6210JSON\u683c\u5f0f\u7684\u63cf\u8ff0\u6587\u4ef6\u3002\u672c\u8eab\u4e0d\u662f\u5c5e\u4e8eSwagger\u5b98\u7f51\u63d0\u4f9b\u7684\uff0c\u5728\u8fd9\u91cc\u5217\u51fa\u6765\u505a\u4e2a\u8bf4\u660e\uff0c\u65b9\u4fbf\u540e\u9762\u4f5c\u4e00\u4e2a\u4f7f\u7528\u7684\u5c55\u5f00\u3002<\/p>\n<h3>2.\u57fa\u4e8eSpring\u6846\u67b6\u7684Swagger\u6d41\u7a0b\u5e94\u7528<\/h3>\n<p>\u8fd9\u91cc\u4e0d\u4f1a\u4ecb\u7ecdSwagger\u7684\u5de5\u5177\u5177\u4f53\u5982\u4f55\u4f7f\u7528\uff0c\u4e0d\u4f1a\u8bb2yml\u6216\u8005json\u683c\u5f0f\u63cf\u8ff0\u6587\u4ef6\u7684\u8bed\u6cd5\u89c4\u8303\uff0c\u4e5f\u4e0d\u4f1a\u8bb2\u5982\u4f55\u5728SpringMVC\u6216\u8005Spring Boot\u4e2d\u914d\u7f6eSpringfox\uff0dswagger\u3002\u8fd9\u4e9b\u90fd\u80fd\u4ece\u7f51\u4e0a\u627e\u5230\uff0c\u800c\u4e14\u914d\u7f6e\u8d77\u6765\u90fd\u975e\u5e38\u7684\u7b80\u5355\u3002<\/p>\n<p>\u8fd9\u91cc\u60f3\u8bb2\u7684\u662f\u5982\u4f55\u7ed3\u5408\u73b0\u6709\u7684\u5de5\u5177\u548c\u529f\u80fd\uff0c\u8bbe\u8ba1\u4e00\u4e2a\u6d41\u7a0b\uff0c\u53bb\u4fdd\u8bc1\u4e00\u4e2a\u9879\u76ee\u4ece\u5f00\u59cb\u5f00\u53d1\u5230\u540e\u9762\u6301\u7eed\u8fed\u4ee3\u7684\u65f6\u5019\uff0c\u4ee5\u6700\u5c0f\u4ee3\u4ef7\u53bb\u7ef4\u62a4\u4ee3\u7801\u3001\u63a5\u53e3\u6587\u6863\u4ee5\u53caSwagger\u63cf\u8ff0\u6587\u4ef6\u3002<\/p>\n<h4>2.1 \u9879\u76ee\u5f00\u59cb\u9636\u6bb5<\/h4>\n<p>\u4e00\u822c\u6765\u8bf4\uff0c\u63a5\u53e3\u6587\u6863\u90fd\u662f\u7531\u670d\u52a1\u7aef\u6765\u7f16\u5199\u7684\u3002\u5728\u9879\u76ee\u5f00\u53d1\u9636\u6bb5\u7684\u65f6\u5019\uff0c\u670d\u52a1\u7aef\u5f00\u53d1\u53ef\u4ee5\u89c6\u60c5\u51b5\u6765\u51b3\u5b9a\u662f\u76f4\u63a5\u7f16\u5199\u670d\u52a1\u7aef\u8c03\u7528\u5c42\u4ee3\u7801\uff0c\u8fd8\u662f\u5199Swagger\u63cf\u8ff0\u6587\u4ef6\u3002\u5efa\u8bae\u662f\u5982\u679c\u9879\u76ee\u542f\u52a8\u9636\u6bb5\uff0c\u5c31\u5df2\u7ecf\u642d\u597d\u4e86\u540e\u53f0\u6846\u67b6\uff0c\u90a3\u53ef\u4ee5\u76f4\u63a5\u7f16\u5199\u670d\u52a1\u7aef\u88ab\u8c03\u7528\u5c42\u7684\u4ee3\u7801\uff08\u5373controller\u53ca\u5176\u5165\u53c2\u51fa\u53c2\u5bf9\u8c61\uff09\uff0c\u7136\u540e\u901a\u8fc7Springfox\uff0dswagger \u751f\u6210swagger json\u63cf\u8ff0\u6587\u4ef6\u3002\u5982\u679c\u9879\u76ee\u542f\u52a8\u9636\u6bb5\u5e76\u6ca1\u6709\u76f8\u5173\u540e\u53f0\u6846\u67b6\uff0c\u800c\u524d\u7aef\u5bf9\u63a5\u53e3\u6587\u6863\u8ffd\u5f97\u7d27\uff0c\u90a3\u5c31\u5efa\u8bae\u5148\u7f16\u5199swagger\u63cf\u8ff0\u6587\u4ef6\uff0c\u901a\u8fc7\u8be5\u63cf\u8ff0\u6587\u4ef6\u751f\u6210\u63a5\u53e3\u6587\u6863\u3002\u540e\u7eed\u540e\u53f0\u6846\u67b6\u642d\u597d\u4e86\uff0c\u4e5f\u53ef\u4ee5\u751f\u6210\u76f8\u5173\u7684\u670d\u52a1\u7aef\u4ee3\u7801\u3002<\/p>\n<h4>2.1 \u9879\u76ee\u8fed\u4ee3\u9636\u6bb5<\/h4>\n<p>\u5230\u8fd9\u4e2a\u9636\u6bb5\uff0c\u4e8b\u60c5\u5c31\u7b80\u5355\u5f88\u591a\u4e86\u3002\u540e\u7eed\u540e\u53f0\u4eba\u5458\uff0c\u65e0\u9700\u5173\u6ce8Swagger\u63cf\u8ff0\u6587\u4ef6\u548c\u63a5\u53e3\u6587\u6863\uff0c\u6709\u9700\u6c42\u53d8\u66f4\u5bfc\u81f4\u63a5\u53e3\u53d8\u5316\uff0c\u76f4\u63a5\u5199\u4ee3\u7801\u5c31\u597d\u4e86\u3002\u628a\u8c03\u7528\u5c42\u7684\u4ee3\u7801\u505a\u4e2a\u4fee\u6539\uff0c\u7136\u540e\u751f\u6210\u65b0\u7684\u63cf\u8ff0\u6587\u4ef6\u548c\u63a5\u53e3\u6587\u6863\u540e\uff0c\u7ed9\u5230\u524d\u7aef\u5373\u53ef\u3002\u771f\u6b63\u505a\u5230\u4e86\u4e00\u52b3\u6c38\u9038\u3002<\/p>\n<h4>2.3\u6d41\u7a0b<\/h4>\n<p>\u603b\u7ed3\u4e00\u4e0b\u5c31\u662f\u901a\u8fc7\u4e0b\u9762\u8fd9\u4e24\u79cd\u6d41\u7a0b\u4e2d\u7684\u4e00\u79cd\uff0c\u53ef\u4ee5\u505a\u5230\u4ee3\u7801\u548c\u63a5\u53e3\u6587\u6863\u7684\u4e00\u81f4\u6027\uff0c\u670d\u52a1\u7aef\u5f00\u53d1\u518d\u4e5f\u4e0d\u7528\u82b1\u8d39\u7cbe\u529b\u53bb\u7ef4\u62a4\u63a5\u53e3\u6587\u6863\u3002<\/p>\n<h5>\u6d41\u7a0b\u4e00<\/h5>\n<div class=\"image-package\">\n<div class=\"image-container\">\n<div class=\"image-container-fill\"><\/div>\n<div class=\"image-view\" data-width=\"1792\" data-height=\"800\"><img decoding=\"async\" class=\"\" src=\"https:\/\/upload-images.jianshu.io\/upload_images\/813533-1879ce94558a8553.png?imageMogr2\/auto-orient\/strip|imageView2\/2\/w\/1200\/format\/webp\" data-original-src=\"\/\/upload-images.jianshu.io\/upload_images\/813533-1879ce94558a8553.png\" data-original-width=\"1792\" data-original-height=\"800\" data-original-format=\"image\/png\" data-original-filesize=\"62076\" data-image-index=\"2\" \/><\/div>\n<\/div>\n<div class=\"image-caption\">image.png<\/div>\n<\/div>\n<h5>\u6d41\u7a0b\u4e8c<\/h5>\n<div class=\"image-package\">\n<div class=\"image-container\">\n<div class=\"image-container-fill\"><\/div>\n<div class=\"image-view\" data-width=\"1676\" data-height=\"638\"><img decoding=\"async\" class=\"\" src=\"https:\/\/upload-images.jianshu.io\/upload_images\/813533-ffc262914e89f87d.png?imageMogr2\/auto-orient\/strip|imageView2\/2\/w\/1200\/format\/webp\" data-original-src=\"\/\/upload-images.jianshu.io\/upload_images\/813533-ffc262914e89f87d.png\" data-original-width=\"1676\" data-original-height=\"638\" data-original-format=\"image\/png\" data-original-filesize=\"49729\" data-image-index=\"3\" \/><\/div>\n<\/div>\n<div class=\"image-caption\">image.png<\/div>\n<\/div>\n<h3>\u7ed9Mock\u7cfb\u7edf\u7684\u6b63\u5e38\u8bf7\u6c42\u53ca\u54cd\u5e94\u5168\u6d41\u7a0b\u6570\u636e<\/h3>\n<p>\u5f88\u591a\u65f6\u5019\uff0c\u5982\u679c\u4f60\u80fd\u5728\u63d0\u4f9b\u63a5\u53e3\u6587\u6863\u7684\u540c\u65f6\uff0c\u628a\u6240\u6709\u63a5\u53e3\u7684\u6a21\u62df\u8bf7\u6c42\u54cd\u5e94\u6570\u636e\u4e5f\u63d0\u4f9b\u7ed9\u524d\u7aef\u3002\u6216\u8005\u6709Mock\u7cfb\u7edf\uff0c\u76f4\u63a5\u5c06\u8fd9\u4e9b\u6a21\u62df\u6570\u636e\u5f55\u5165\u5230Mock\u7cfb\u7edf\u4e2d\uff0c\u90a3\u5c06\u4f1a\u63d0\u9ad8\u524d\u7aef\u7684\u5f00\u53d1\u6548\u7387\uff0c\u51cf\u5c11\u8bb8\u591a\u53d1\u751f\u5728\u8054\u8c03\u65f6\u5019\u624d\u4f1a\u53d1\u751f\u7684\u95ee\u9898\u3002<\/p>\n<p>\u901a\u8fc7\u9002\u5f53\u5730\u5728\u4ee3\u7801\u4e2d\u52a0\u5165swagger\u7684\u6ce8\u89e3\uff0c\u53ef\u4ee5\u8ba9\u4f60\u7684\u63a5\u53e3\u6587\u6863\u63cf\u8ff0\u4fe1\u606f\u66f4\u52a0\u8be6\u7ec6\uff0c\u5982\u679c\u4f60\u628a\u6bcf\u4e2a\u51fa\u5165\u53c2\u6570\u7684\u793a\u4f8b\u503c\u90fd\u914d\u4e0a\uff0c\u90a3\u524d\u7aef\u5c31\u53ef\u4ee5\u76f4\u63a5\u5728\u63a5\u53e3\u6587\u6863\u4e2d\u62ff\u5230\u6a21\u62df\u6570\u636e\u3002\u76f8\u5173\u7684\u6ce8\u89e3\u7c7b\u53ca\u53c2\u6570\u914d\u7f6e\u53ef\u4ee5\u53c2\u8003\u6587\u672b\u4ed6\u4eba\u5199\u7684\u6280\u672f\u6587\u7ae0\uff0c\u8fd9\u91cc\u4e5f\u4e0d\u4f5c\u5c55\u5f00\u4e86\u3002<\/p>\n<p>\u76f8\u5173\u793a\u4f8b\u6ce8\u89e3\u4ee3\u7801\u548c\u6548\u679c\u56fe\u5982\u4e0b\uff1a<\/p>\n<div class=\"_2Uzcx_\"><button class=\"VJbwyy\" type=\"button\" aria-label=\"\u590d\u5236\u4ee3\u7801\"><i class=\"anticon anticon-copy\" aria-label=\"icon: copy\"><\/i><\/button><\/p>\n<pre class=\"line-numbers  language-kotlin\"><code class=\"  language-kotlin\">\r\n#####Controller\u4ee3\u7801\r\n<span class=\"token annotation builtin\">@Override<\/span>\r\n    <span class=\"token annotation builtin\">@ApiOperation<\/span><span class=\"token punctuation\">(<\/span>value <span class=\"token operator\">=<\/span> <span class=\"token string\">\"post\u8bf7\u6c42\u8c03\u7528\u793a\u4f8b\"<\/span><span class=\"token punctuation\">,<\/span> notes <span class=\"token operator\">=<\/span> <span class=\"token string\">\"invokePost\u8bf4\u660e\"<\/span><span class=\"token punctuation\">,<\/span> httpMethod <span class=\"token operator\">=<\/span> <span class=\"token string\">\"POST\"<\/span><span class=\"token punctuation\">)<\/span>\r\n    <span class=\"token keyword\">public<\/span> FFResponseModel<span class=\"token operator\">&lt;<\/span>DemoOutputDto<span class=\"token operator\">&gt;<\/span> <span class=\"token function\">invokePost<\/span><span class=\"token punctuation\">(<\/span><span class=\"token annotation builtin\">@ApiParam<\/span><span class=\"token punctuation\">(<\/span>name<span class=\"token operator\">=<\/span><span class=\"token string\">\"\u4f20\u5165\u5bf9\u8c61\"<\/span><span class=\"token punctuation\">,<\/span>value<span class=\"token operator\">=<\/span><span class=\"token string\">\"\u4f20\u5165json\u683c\u5f0f\"<\/span><span class=\"token punctuation\">,<\/span>required<span class=\"token operator\">=<\/span><span class=\"token boolean\">true<\/span><span class=\"token punctuation\">)<\/span> <span class=\"token annotation builtin\">@RequestBody<\/span> <span class=\"token annotation builtin\">@Valid<\/span> DemoDto input<span class=\"token punctuation\">)<\/span> <span class=\"token punctuation\">{<\/span>\r\n        log<span class=\"token punctuation\">.<\/span><span class=\"token function\">info<\/span><span class=\"token punctuation\">(<\/span><span class=\"token string\">\"\/testPost is called. input=\"<\/span> <span class=\"token operator\">+<\/span> input<span class=\"token punctuation\">.<\/span><span class=\"token function\">toString<\/span><span class=\"token punctuation\">(<\/span><span class=\"token punctuation\">)<\/span><span class=\"token punctuation\">)<\/span><span class=\"token punctuation\">;<\/span>\r\n        <span class=\"token keyword\">return<\/span> new <span class=\"token function\">FFResponseModel<\/span><span class=\"token punctuation\">(<\/span>Errcode<span class=\"token punctuation\">.<\/span>SUCCESS_CODE<span class=\"token punctuation\">,<\/span> Errcode<span class=\"token punctuation\">.<\/span>SUCCESS_MSG<span class=\"token punctuation\">)<\/span><span class=\"token punctuation\">;<\/span>\r\n    <span class=\"token punctuation\">}<\/span>\r\n\r\n\r\n#####\u63a5\u53e3\u8bf7\u6c42\u5165\u53c2\u5bf9\u8c61   \r\n<span class=\"token annotation builtin\">@Data<\/span>\r\n<span class=\"token annotation builtin\">@ApiModel<\/span><span class=\"token punctuation\">(<\/span>value<span class=\"token operator\">=<\/span><span class=\"token string\">\"\u6f14\u793a\u7c7b\"<\/span><span class=\"token punctuation\">,<\/span>description<span class=\"token operator\">=<\/span><span class=\"token string\">\"\u8bf7\u6c42\u53c2\u6570\u7c7b\"<\/span> <span class=\"token punctuation\">)<\/span>\r\n<span class=\"token keyword\">public<\/span> <span class=\"token keyword\">class<\/span> DemoDto implements Serializable <span class=\"token punctuation\">{<\/span>\r\n\r\n    <span class=\"token keyword\">private<\/span> static <span class=\"token keyword\">final<\/span> long serialVersionUID <span class=\"token operator\">=<\/span> <span class=\"token number\">1L<\/span><span class=\"token punctuation\">;<\/span>\r\n\r\n    <span class=\"token annotation builtin\">@NotNull<\/span>\r\n    <span class=\"token annotation builtin\">@ApiModelProperty<\/span><span class=\"token punctuation\">(<\/span>value <span class=\"token operator\">=<\/span> <span class=\"token string\">\"defaultStr\"<\/span><span class=\"token punctuation\">,<\/span>example<span class=\"token operator\">=<\/span><span class=\"token string\">\"mockStrValue\"<\/span><span class=\"token punctuation\">)<\/span>\r\n    <span class=\"token keyword\">private<\/span> String strDemo<span class=\"token punctuation\">;<\/span>\r\n\r\n    <span class=\"token annotation builtin\">@NotNull<\/span>\r\n    <span class=\"token annotation builtin\">@ApiModelProperty<\/span><span class=\"token punctuation\">(<\/span>example<span class=\"token operator\">=<\/span><span class=\"token string\">\"1234343523\"<\/span><span class=\"token punctuation\">,<\/span>required <span class=\"token operator\">=<\/span> <span class=\"token boolean\">true<\/span><span class=\"token punctuation\">)<\/span>\r\n    <span class=\"token keyword\">private<\/span> Long longNum<span class=\"token punctuation\">;<\/span>\r\n\r\n    <span class=\"token annotation builtin\">@NotNull<\/span>\r\n    <span class=\"token annotation builtin\">@ApiModelProperty<\/span><span class=\"token punctuation\">(<\/span>example<span class=\"token operator\">=<\/span><span class=\"token string\">\"111111.111\"<\/span><span class=\"token punctuation\">)<\/span>\r\n    <span class=\"token keyword\">private<\/span> Double doubleNum<span class=\"token punctuation\">;<\/span>\r\n\r\n    <span class=\"token annotation builtin\">@NotNull<\/span>\r\n    <span class=\"token annotation builtin\">@ApiModelProperty<\/span><span class=\"token punctuation\">(<\/span>example<span class=\"token operator\">=<\/span><span class=\"token string\">\"2018-12-04T13:46:56.711Z\"<\/span><span class=\"token punctuation\">)<\/span>\r\n    <span class=\"token keyword\">private<\/span> Date date<span class=\"token punctuation\">;<\/span>\r\n    \r\n<span class=\"token punctuation\">}<\/span>\r\n\r\n#####\u63a5\u53e3\u8bf7\u6c42\u51fa\u53c2\u516c\u5171\u7c7b\r\n<span class=\"token annotation builtin\">@ApiModel<\/span><span class=\"token punctuation\">(<\/span>value<span class=\"token operator\">=<\/span><span class=\"token string\">\"\u57fa\u7840\u8fd4\u56de\u7c7b\"<\/span><span class=\"token punctuation\">,<\/span>description<span class=\"token operator\">=<\/span><span class=\"token string\">\"\u57fa\u7840\u8fd4\u56de\u7c7b\"<\/span><span class=\"token punctuation\">)<\/span>\r\n<span class=\"token keyword\">public<\/span> <span class=\"token keyword\">class<\/span> FFResponseModel<span class=\"token operator\">&lt;<\/span>T<span class=\"token operator\">&gt;<\/span> implements Serializable <span class=\"token punctuation\">{<\/span>\r\n\r\n    <span class=\"token keyword\">private<\/span> static <span class=\"token keyword\">final<\/span> long serialVersionUID <span class=\"token operator\">=<\/span> <span class=\"token operator\">-<\/span><span class=\"token number\">2215304260629038881L<\/span><span class=\"token punctuation\">;<\/span>\r\n    <span class=\"token comment\">\/\/ \u72b6\u6001\u7801<\/span>\r\n    <span class=\"token annotation builtin\">@ApiModelProperty<\/span><span class=\"token punctuation\">(<\/span>example<span class=\"token operator\">=<\/span><span class=\"token string\">\"\u6210\u529f\"<\/span><span class=\"token punctuation\">)<\/span>\r\n    <span class=\"token keyword\">private<\/span> String code<span class=\"token punctuation\">;<\/span>\r\n    <span class=\"token comment\">\/\/ \u4e1a\u52a1\u63d0\u793a\u8bed<\/span>\r\n    <span class=\"token annotation builtin\">@ApiModelProperty<\/span><span class=\"token punctuation\">(<\/span>example<span class=\"token operator\">=<\/span><span class=\"token string\">\"000000\"<\/span><span class=\"token punctuation\">)<\/span>\r\n    <span class=\"token keyword\">private<\/span> String msg<span class=\"token punctuation\">;<\/span>\r\n    <span class=\"token comment\">\/\/ \u6570\u636e\u5bf9\u8c61<\/span>\r\n    <span class=\"token keyword\">private<\/span> T <span class=\"token keyword\">data<\/span><span class=\"token punctuation\">;<\/span>\r\n\r\n<span class=\"token operator\">..<\/span><span class=\"token punctuation\">.<\/span>\r\n<span class=\"token punctuation\">}<\/span>\r\n\r\n#####\u63a5\u53e3\u8bf7\u6c42\u51fa\u53c2\u5b9e\u9645\u6570\u636e\u5bf9\u8c61\r\n<span class=\"token annotation builtin\">@Data<\/span>\r\n<span class=\"token keyword\">public<\/span> <span class=\"token keyword\">class<\/span> DemoOutputDto <span class=\"token punctuation\">{<\/span>\r\n\r\n    <span class=\"token keyword\">private<\/span> String res<span class=\"token punctuation\">;<\/span>\r\n\r\n    <span class=\"token annotation builtin\">@NotNull<\/span>\r\n    <span class=\"token annotation builtin\">@ApiModelProperty<\/span><span class=\"token punctuation\">(<\/span>value <span class=\"token operator\">=<\/span> <span class=\"token string\">\"defaultOutputStr\"<\/span><span class=\"token punctuation\">,<\/span>example<span class=\"token operator\">=<\/span><span class=\"token string\">\"mockOutputStrValue\"<\/span><span class=\"token punctuation\">)<\/span>\r\n    <span class=\"token keyword\">private<\/span> String outputStrDemo<span class=\"token punctuation\">;<\/span>\r\n\r\n    <span class=\"token annotation builtin\">@NotNull<\/span>\r\n    <span class=\"token annotation builtin\">@ApiModelProperty<\/span><span class=\"token punctuation\">(<\/span>example<span class=\"token operator\">=<\/span><span class=\"token string\">\"6666666\"<\/span><span class=\"token punctuation\">,<\/span>required <span class=\"token operator\">=<\/span> <span class=\"token boolean\">true<\/span><span class=\"token punctuation\">)<\/span>\r\n    <span class=\"token keyword\">private<\/span> Long outputLongNum<span class=\"token punctuation\">;<\/span>\r\n\r\n    <span class=\"token annotation builtin\">@NotNull<\/span>\r\n    <span class=\"token annotation builtin\">@ApiModelProperty<\/span><span class=\"token punctuation\">(<\/span>example<span class=\"token operator\">=<\/span><span class=\"token string\">\"88888.888\"<\/span><span class=\"token punctuation\">)<\/span>\r\n    <span class=\"token keyword\">private<\/span> Double outputDoubleNum<span class=\"token punctuation\">;<\/span>\r\n\r\n    <span class=\"token annotation builtin\">@NotNull<\/span>\r\n    <span class=\"token annotation builtin\">@ApiModelProperty<\/span><span class=\"token punctuation\">(<\/span>example<span class=\"token operator\">=<\/span><span class=\"token string\">\"2018-12-12T11:11:11.111Z\"<\/span><span class=\"token punctuation\">)<\/span>\r\n    <span class=\"token keyword\">private<\/span> Date outputDate<span class=\"token punctuation\">;<\/span>\r\n    \r\n<span class=\"token punctuation\">}<\/span>\r\n\r\n\r\n    \r\n<\/code><\/pre>\n<\/div>\n<h3>\u6548\u679c\u56fe<\/h3>\n<p>\u6a21\u62df\u8bf7\u6c42\u6570\u636e\u62a5\u6587\uff1a<\/p>\n<div class=\"image-package\">\n<div class=\"image-container\">\n<div class=\"image-container-fill\"><\/div>\n<div class=\"image-view\" data-width=\"680\" data-height=\"480\"><img decoding=\"async\" class=\"\" src=\"https:\/\/upload-images.jianshu.io\/upload_images\/813533-53ebc98f9caf9697.png?imageMogr2\/auto-orient\/strip|imageView2\/2\/w\/680\/format\/webp\" data-original-src=\"\/\/upload-images.jianshu.io\/upload_images\/813533-53ebc98f9caf9697.png\" data-original-width=\"680\" data-original-height=\"480\" data-original-format=\"image\/png\" data-original-filesize=\"43879\" data-image-index=\"4\" \/><\/div>\n<\/div>\n<div class=\"image-caption\">image.png<\/div>\n<\/div>\n<div class=\"image-package\">\n<div class=\"image-container\">\n<div class=\"image-container-fill\"><\/div>\n<div class=\"image-view\" data-width=\"544\" data-height=\"338\"><img decoding=\"async\" class=\"\" src=\"https:\/\/upload-images.jianshu.io\/upload_images\/813533-0bef05ce060c1556.png?imageMogr2\/auto-orient\/strip|imageView2\/2\/w\/544\/format\/webp\" data-original-src=\"\/\/upload-images.jianshu.io\/upload_images\/813533-0bef05ce060c1556.png\" data-original-width=\"544\" data-original-height=\"338\" data-original-format=\"image\/png\" data-original-filesize=\"43427\" data-image-index=\"5\" \/><\/div>\n<\/div>\n<div class=\"image-caption\">image.png<\/div>\n<\/div>\n<p>\u6a21\u62df\u8fd4\u56de\u6570\u636e\u62a5\u6587\uff1a<\/p>\n<div class=\"image-package\">\n<div class=\"image-container\">\n<div class=\"image-container-fill\"><\/div>\n<div class=\"image-view\" data-width=\"1400\" data-height=\"1060\"><img decoding=\"async\" class=\"\" src=\"https:\/\/upload-images.jianshu.io\/upload_images\/813533-ccd38a9fbcad3f33.png?imageMogr2\/auto-orient\/strip|imageView2\/2\/w\/1200\/format\/webp\" data-original-src=\"\/\/upload-images.jianshu.io\/upload_images\/813533-ccd38a9fbcad3f33.png\" data-original-width=\"1400\" data-original-height=\"1060\" data-original-format=\"image\/png\" data-original-filesize=\"136417\" data-image-index=\"6\" \/><\/div>\n<\/div>\n<div class=\"image-caption\">image.png<\/div>\n<\/div>\n<h2>\u603b\u7ed3<\/h2>\n<p>\u5176\u5b9e\u5f52\u6839\u5230\u5e95\uff0c\u4f7f\u7528Swagger\uff0c\u5c31\u662f\u628a\u76f8\u5173\u7684\u4fe1\u606f\u5b58\u50a8\u5728\u5b83\u5b9a\u4e49\u7684\u63cf\u8ff0\u6587\u4ef6\u91cc\u9762\uff08yml\u6216json\u683c\u5f0f\uff09\uff0c\u518d\u901a\u8fc7\u7ef4\u62a4\u8fd9\u4e2a\u63cf\u8ff0\u6587\u4ef6\u53ef\u4ee5\u53bb\u66f4\u65b0\u63a5\u53e3\u6587\u6863\uff0c\u4ee5\u53ca\u751f\u6210\u5404\u7aef\u4ee3\u7801\u3002\u800cSpringfox-swagger,\u5219\u53ef\u4ee5\u901a\u8fc7\u626b\u63cf\u4ee3\u7801\u53bb\u751f\u6210\u8fd9\u4e2a\u63cf\u8ff0\u6587\u4ef6\uff0c\u8fde\u63cf\u8ff0\u6587\u4ef6\u90fd\u4e0d\u9700\u8981\u518d\u53bb\u7ef4\u62a4\u4e86\u3002\u6240\u6709\u7684\u4fe1\u606f\uff0c\u90fd\u5728\u4ee3\u7801\u91cc\u9762\u4e86\u3002\u4ee3\u7801\u5373\u63a5\u53e3\u6587\u6863\uff0c\u63a5\u53e3\u6587\u6863\u5373\u4ee3\u7801\u3002<\/p>\n<h2>\u76f8\u5173\u6280\u672f\u8d44\u6599\u7ad9<\/h2>\n<ul>\n<li><a href=\"https:\/\/swagger.io\/\" target=\"_blank\" rel=\"nofollow noopener\">SWAGGER \u5b98\u7f51<\/a><\/li>\n<li><a href=\"https:\/\/blog.csdn.net\/zmh458\/article\/details\/78766895\" target=\"_blank\" rel=\"nofollow noopener\">\u3010\u5de5\u5177\u4f7f\u7528\u3011API\u8868\u8fbe\u5de5\u5177&#8212;-swagger<\/a><\/li>\n<li><a href=\"https:\/\/blog.csdn.net\/wyb880501\/article\/details\/79576784\" target=\"_blank\" rel=\"nofollow noopener\">Swagger \u5e38\u7528\u6ce8\u89e3\u4f7f\u7528\u8be6\u89e3<\/a><\/li>\n<\/ul>\n<\/article>\n","protected":false},"excerpt":{"rendered":"<p>\u539f\u6587\u5730\u5740 wuqke\u5173\u6ce8 172018.<\/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-5863","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\/5863","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=5863"}],"version-history":[{"count":0,"href":"https:\/\/i007.cc\/wordpress\/wp-json\/wp\/v2\/posts\/5863\/revisions"}],"wp:attachment":[{"href":"https:\/\/i007.cc\/wordpress\/wp-json\/wp\/v2\/media?parent=5863"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/i007.cc\/wordpress\/wp-json\/wp\/v2\/categories?post=5863"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/i007.cc\/wordpress\/wp-json\/wp\/v2\/tags?post=5863"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}