{"id":3767,"date":"2024-04-09T15:34:38","date_gmt":"2024-04-09T07:34:38","guid":{"rendered":"https:\/\/xinchewhd.com.cn\/?p=3767"},"modified":"2024-04-09T15:34:40","modified_gmt":"2024-04-09T07:34:40","slug":"%e5%b8%b8%e7%94%a8swagger%e6%b3%a8%e8%a7%a3%e6%b1%87%e6%80%bb","status":"publish","type":"post","link":"https:\/\/xinchewhd.com.cn\/index.php\/java\/%e5%b8%b8%e7%94%a8swagger%e6%b3%a8%e8%a7%a3%e6%b1%87%e6%80%bb\/","title":{"rendered":"\u5e38\u7528Swagger\u6ce8\u89e3\u6c47\u603b"},"content":{"rendered":"\n<ul class=\"wp-block-list\">\n<li>\u5e38\u7528Swagger\u6ce8\u89e3\u6c47\u603b<\/li>\n\n\n\n<li>\u63a7\u5236\u5668\u5c42\n<ul class=\"wp-block-list\">\n<li>@Api<\/li>\n\n\n\n<li>@ApiOperation<\/li>\n\n\n\n<li>@ApiImplicitParam<\/li>\n\n\n\n<li>@ApiImplicitParams<\/li>\n\n\n\n<li>@ApiParam<\/li>\n<\/ul>\n<\/li>\n\n\n\n<li>\u5b9e\u4f53\u5c42\n<ul class=\"wp-block-list\">\n<li>@ApiModel<\/li>\n\n\n\n<li>@ApiModelProperty<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n\n\n\n<p>@Api<\/p>\n\n\n<p>\u6b64\u6ce8\u89e3\u5e94\u7528\u4e8e\u7c7b\u3001\u63a5\u53e3\u6216\u8005\u679a\u4e3e\u4e0a\uff0c\u542f\u52a8\u5e94\u7528\u65f6\u88ab\u6807\u6ce8\u7684\u7c7b\u4f1a\u626b\u63cf\u5230 swagger \u6e90\u4e2d\u3002\u9ed8\u8ba4\u60c5\u51b5\u4e0b\uff0cswagger \u6838\u5fc3\u4ec5\u626b\u63cf\u5e26\u6709 @Api \u6ce8\u89e3\u7684\u7c7b\u800c\u65e0\u89c6\u5176\u4ed6\u7684\u6e90\u6570\u636e (\u4f8b\u5982\uff1aJAX-RS \u7aef\u53e3\u3001Serlvet \u7b49\u7b49)<\/p>\n<p>\u4e0d\u80fd\u6807\u6ce8\u5728\u65b9\u6cd5\u4e0a\u4e14\u4e00\u822c\u4e0d\u5355\u72ec\u4f7f\u7528\uff0c\u5e38\u89c1\u7684\u505a\u6cd5\u662f\u642d\u914d @ApiOperation \u6ce8\u89e3\uff0c\u4f5c\u4e3a\u4e1a\u52a1\u63a5\u53e3\u7c7b\u7684\u8bf4\u660e\u3002<\/p>\n\n\n<pre class=\"wp-block-code\"><code>\/\/\n\/\/ Source code recreated from a .class file by IntelliJ IDEA\n\/\/ (powered by FernFlower decompiler)\n\/\/\n\npackage io.swagger.annotations;\n\nimport java.lang.annotation.ElementType;\nimport java.lang.annotation.Inherited;\nimport java.lang.annotation.Retention;\nimport java.lang.annotation.RetentionPolicy;\nimport java.lang.annotation.Target;\n\n@Target({ElementType.TYPE})\n@Retention(RetentionPolicy.RUNTIME)\n@Inherited\npublic @interface Api {\n    String value() default \"\";\n\n    String&#91;] tags() default {\"\"};\n\n    \/** @deprecated *\/\n    @Deprecated\n    String description() default \"\";\n\n    \/** @deprecated *\/\n    @Deprecated\n    String basePath() default \"\";\n\n    \/** @deprecated *\/\n    @Deprecated\n    int position() default 0;\n\n    String produces() default \"\";\n\n    String consumes() default \"\";\n\n    String protocols() default \"\";\n\n    Authorization&#91;] authorizations() default {@Authorization(\"\")};\n\n    boolean hidden() default false;\n}\n<\/code><\/pre>\n\n\n<p>\u4ece\u6e90\u7801\u6211\u4eec\u53ef\u4ee5\u770b\u5230&nbsp;<code>@Api<\/code>&nbsp;\u6ce8\u89e3\u9664\u4e86\u5df2\u5e9f\u5f03\u76843\u4e2a\uff0c\u5171\u6709 7 \u4e2a\u5c5e\u6027\uff0c\u4e0d\u8fc7\u8fd9\u91cc\u9762\u53ea\u6709\u4e0b\u9762\u8fd91\u4e2a\u5c5e\u6027\u6bd4\u8f83\u5e38\u7528\uff1a<\/p>\n\n\n<ol class=\"wp-block-list\">\n<li><strong>tags<\/strong>&nbsp;(\u63a5\u53e3\u4e1a\u52a1\u6240\u5c5e\u5206\u7ec4)<\/li>\n<\/ol>\n\n\n\n<figure class=\"wp-block-image size-large\"><img loading=\"lazy\" decoding=\"async\" width=\"1024\" height=\"473\" data-src=\"https:\/\/wp-moto-1258805347.cos.ap-shanghai.myqcloud.com\/2024\/03\/20240302031711507-1024x473.png\" src=\"https:\/\/s.nmxc.ltd\/sakurairo_vision\/@2.6\/load_svg\/inload.svg\" onerror=\"imgError(this)\" alt=\"\" class=\"wp-image-3768 lazyload\" srcset=\"https:\/\/wp-moto-1258805347.cos.ap-shanghai.myqcloud.com\/2024\/03\/20240302031711507-1024x473.png 1024w, https:\/\/wp-moto-1258805347.cos.ap-shanghai.myqcloud.com\/2024\/03\/20240302031711507-300x139.png 300w, https:\/\/wp-moto-1258805347.cos.ap-shanghai.myqcloud.com\/2024\/03\/20240302031711507-768x355.png 768w, https:\/\/wp-moto-1258805347.cos.ap-shanghai.myqcloud.com\/2024\/03\/20240302031711507-1536x710.png 1536w, https:\/\/wp-moto-1258805347.cos.ap-shanghai.myqcloud.com\/2024\/03\/20240302031711507.png 1912w\" sizes=\"auto, (max-width: 1024px) 100vw, 1024px\" \/><noscript><img loading=\"lazy\" decoding=\"async\" width=\"1024\" height=\"473\" src=\"https:\/\/wp-moto-1258805347.cos.ap-shanghai.myqcloud.com\/2024\/03\/20240302031711507-1024x473.png\" alt=\"\" class=\"wp-image-3768\" srcset=\"https:\/\/wp-moto-1258805347.cos.ap-shanghai.myqcloud.com\/2024\/03\/20240302031711507-1024x473.png 1024w, https:\/\/wp-moto-1258805347.cos.ap-shanghai.myqcloud.com\/2024\/03\/20240302031711507-300x139.png 300w, https:\/\/wp-moto-1258805347.cos.ap-shanghai.myqcloud.com\/2024\/03\/20240302031711507-768x355.png 768w, https:\/\/wp-moto-1258805347.cos.ap-shanghai.myqcloud.com\/2024\/03\/20240302031711507-1536x710.png 1536w, https:\/\/wp-moto-1258805347.cos.ap-shanghai.myqcloud.com\/2024\/03\/20240302031711507.png 1912w\" sizes=\"auto, (max-width: 1024px) 100vw, 1024px\" \/><\/noscript><\/figure>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td><strong>\u5c5e\u6027<\/strong><\/td><td>\u6570\u636e\u7c7b\u578b<\/td><td>\u9ed8\u8ba4\u503c<\/td><td>\u4f5c\u7528<\/td><td>\u793a\u4f8b<\/td><td>\u8bf4\u660e<\/td><\/tr><tr><td>value<\/td><td>String<\/td><td>\u201c\u201d<br><\/td><td>\u63a5\u53e3\u5206\u7ec4\u8bf4\u660e\uff0c\u5728\u5b9e\u9645\u5f00\u53d1\u4e2d\u5e76\u4e0d\u5e38\u7528\uff0c\u4e14\u503c\u4f1a\u88ab tags \u5c5e\u6027\u8986\u76d6<\/td><td>@Api(value = \u201c\u64cd\u4f5c\u540d\u79f0\u201d) \u6216 @Api(\u201c\u64cd\u4f5c\u540d\u79f0\u201d)<\/td><td>\u9690\u5f0f\u5730\u8bbe\u7f6e\u64cd\u4f5c\u6807\u7b7e (\u5373\u64cd\u4f5c\u540d\u79f0)\uff0c\u65e7\u7248\u672c\u652f\u6301 (\u9605\u8bfb\u63cf\u8ff0)\u3002<br>\u5728 Swagger \u6838\u5fc3 1.3.X \u7684\u7248\u672c\u4e2d\uff0c\u6b64\u5c5e\u6027\u4ec5\u4f5c\u4e3a\u4e3b\u673a API \u8d44\u6e90\u7684\u58f0\u660e<strong>\u8def\u5f84<\/strong>\uff0c\u5230 1.5.X \u7248\u672c\u4e4b\u540e\u5c31\u4e0d\u518d\u5173\u8054\u4e86\u3002<\/td><\/tr><tr><td>hidden<\/td><td>boolean<\/td><td>false<\/td><td>\u9690\u85cf\u8be5\u5206\u7ec4\u4e0b\u7684\u6240\u6709\u63a5\u53e3\u3002\u6b64\u5916\u8981\u6ce8\u610f\u7684\u662f\uff0c\u63a5\u53e3\u7684\u663e\u793a\u9690\u85cf\u5e94\u8be5\u6839\u636e\u7279\u5b9a\u7684\u5b89\u5168\u7b56\u7565\u548c\u7279\u5b9a\u5ba2\u6237\u9700\u6c42\u6765\u786e\u5b9a<\/td><td>@Api(hidden = true)<\/td><td>\u9690\u85cf\u8d44\u6e90\u4e0b\u7684\u64cd\u4f5c\u3002<br>\u6b64\u5c5e\u6027\u7684\u503c\u9ed8\u8ba4\u4e3a false\uff0c\u5f53\u8bbe\u7f6e\u4e3a true \u65f6\uff0c\u8be5\u5206\u7ec4\u7684\u6240\u6709\u64cd\u4f5c\u90fd\u4f1a\u5728 swagger \u6587\u6863\u4e2d\u88ab\u9690\u85cf\uff0c\u9002\u7528\u4e8e\u63a5\u53e3\u6682\u65f6\u4e0d\u9700\u8981\u4f7f\u7528\u65f6\u7684\u60c5\u51b5\u3002<\/td><\/tr><tr><td>produces<\/td><td>String<\/td><td>\u201c\u201d<\/td><td>\u6307\u5b9a\u7684content-type \u7684\u8f93\u51fa<\/td><td>@Api(produces=\u201capplication\/json\u201d<\/td><td>\u6b64\u5c5e\u6027\u5728\u65b0\u7248\u672c\u7684 swagger \u4e2d\u5df2\u4e0d\u518d\u4f7f\u7528\uff0c\u4ec5\u7528\u4e8e\u5411\u4e0b\u517c\u5bb9\u65e7\u7248\u672c\u3002\u5bf9\u5e94\u6b64\u8d44\u6e90\u4e0b\u64cd\u4f5c\u751f\u6210\u7684\u5b57\u6bb5\u3002<br>\u83b7\u53d6\u9017\u53f7\u5206\u5272\u7684\u5185\u5bb9\u7c7b\u578b\u503c\uff0c\u4f8b\u5982\uff0c\u201capplication\/json\u201d\uff0c\u201capplication\/xml\u201d \u5c06\u4f1a\u63d0\u9192\u64cd\u4f5c\u751f\u6210 JSON \u6216 XML \u8f93\u51fa\u3002<br>\u5bf9\u4e8e JAX-RS \u8d44\u6e90\uff0c\u5982\u679c\u5b58\u5728\u5c06\u4f1a\u81ea\u52a8\u83b7\u53d6 @Produces \u6ce8\u89e3\u7684\u503c\uff0c\u540c\u65f6\u4e5f\u53ef\u7528\u4e8e\u8986\u76d6 Swapper \u6587\u6863\u7684 @Produces \u7684\u503c\u3002<\/td><\/tr><tr><td>consumes<\/td><td>String<\/td><td>\u201c\u201d<\/td><td>\u6307\u5b9a\u7684content-type \u7684\u8f93\u5165<\/td><td>@Api(consumes=\u201capplication\/xml\u201d)<\/td><td>\u5bf9\u5e94\u6b64\u8d44\u6e90\u4e0b\u64cd\u4f5c\u6d88\u8d39\u7684\u5b57\u6bb5\u3002<br>\u83b7\u53d6\u9017\u53f7\u5206\u5272\u7684\u5185\u5bb9\u7c7b\u578b\u503c\u3002\u4f8b\u5982\u4f8b\u5982\uff0c\u201capplication\/json\u201d\uff0c\u201capplication\/xml\u201d \u5c06\u4f1a\u63d0\u9192\u64cd\u4f5c\u63a5\u6536 JSON \u6216 XML \u8f93\u5165\u3002<br>\u5bf9\u4e8e JAX-RS \u8d44\u6e90\uff0c\u5982\u679c\u5b58\u5728\u5c06\u4f1a\u81ea\u52a8\u83b7\u53d6 @Consumes \u6ce8\u89e3\u7684\u503c\uff0c\u540c\u65f6\u4e5f\u53ef\u7528\u4e8e\u8986\u76d6 Swagger \u6587\u6863\u7684 @Consumes \u7684\u503c\u3002<\/td><\/tr><tr><td>protocols<\/td><td>String<\/td><td>\u201c\u201d<\/td><td>\u7f51\u7edc\u8bf7\u6c42\u534f\u8bae<\/td><td>@Api(protocols = \u201chttp,https\u201d)<\/td><td>\u8bbe\u7f6e\u6b64\u8d44\u6e90\u4e0b\u64cd\u4f5c\u7684\u6307\u5b9a\u534f\u8bae(\u6216\u65b9\u6848)\u3002<br>\u4ee5\u9017\u53f7\u5206\u5272\u53ef\u7528\u7684\u534f\u8bae\u503c\uff0c\u53ef\u7528\u503c\uff1ahttp, https, ws, wss<\/td><\/tr><tr><td>authorizations<\/td><td>Authorization[]<\/td><td>@Authorization(value = \u201c\u201d)<\/td><td>\u89c4\u5b9a\u63a5\u53e3\u5206\u7ec4\u7684\u6388\u6743\u65b9\u6848<br><\/td><td><\/td><td>\u5bf9\u5e94\u64cd\u4f5c\u5bf9\u8c61\u7684<strong>\u5b89\u5168<\/strong>\u5b57\u6bb5\u3002<br>\u83b7\u53d6\u6b64\u8d44\u6e90\u4e0b\u64cd\u4f5c\u7684\u6388\u6743 (\u5b89\u5168\u9700\u6c42) \u5217\u8868\uff0c\u8fd9\u53ef\u80fd\u4f1a\u88ab\u7279\u5b9a\u7684\u64cd\u4f5c\u8986\u76d6\u3002<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<p>@ApiOperation<\/p>\n\n\n\n<p>@ApiOperation \u6ce8\u89e3\u53ef\u5e94\u7528\u4e8e\u65b9\u6cd5\u6216\u7c7b\u4e0a\uff0c\u901a\u5e38\u6807\u6ce8\u5728\u65b9\u6cd5\u4e0a\u4f5c\u4e3a\u4e1a\u52a1\u63a5\u53e3\u7684\u540d\u79f0\uff0c\u63cf\u8ff0\u5176\u64cd\u4f5c\u6216\u8005\u63cf\u8ff0\u9488\u5bf9\u4e8e\u7279\u5b9a\u8def\u5f84\u7684 HTTP \u65b9\u6cd5\u3002\u9ed8\u8ba4\u60c5\u51b5\u4e0b\uff0c\u5177\u6709\u76f8\u540c\u6548\u679c\u7684\u64cd\u4f5c\u88ab\u5206\u7ec4\u5728\u4e00\u4e2a\u5355\u72ec\u7684\u64cd\u4f5c\u5bf9\u8c61\u4e2d\uff0c\u800c HTTP \u65b9\u6cd5\u548c\u8def\u5f84\u7684\u7ec4\u5408\u5c06\u4f1a\u521b\u5efa\u4e00\u4e2a\u72ec\u4e00\u65e0\u4e8c\u7684\u64cd\u4f5c\u3002\u6b64\u5916\uff0c\u6b64\u6ce8\u89e3\u63d0\u4f9b\u4e86\u4e30\u5bcc\u7684\u5c5e\u6027\u6765\u5141\u8bb8\u6211\u4eec\u81ea\u5b9a\u4e49\u63a5\u53e3\u7684\u63cf\u8ff0\u4fe1\u606f\uff0c\u5305\u62ec\u63a5\u53e3\u540d\u79f0\u548c\u6240\u5c5e\u5206\u7ec4\u7b49\u3002<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>package io.swagger.annotations;\n\nimport java.lang.annotation.ElementType;\nimport java.lang.annotation.Retention;\nimport java.lang.annotation.RetentionPolicy;\nimport java.lang.annotation.Target;\n\n@Target({ElementType.METHOD, ElementType.TYPE})\n@Retention(RetentionPolicy.RUNTIME)\npublic @interface ApiOperation {\n\n    String value();\n\n    String notes() default \"\";\n\n    String&#91;] tags() default \"\";\n\n    Class&lt;?&gt; response() default Void.class;\n\n    String responseContainer() default \"\";\n\n    String responseReference() default \"\";\n\n    String httpMethod() default \"\";\n\n    @Deprecated int position() default 0;\n\n    String nickname() default \"\";\n\n    String produces() default \"\";\n\n    String consumes() default \"\";\n\n    String protocols() default \"\";\n\n    Authorization&#91;] authorizations() default @Authorization(value = \"\");\n\n    boolean hidden() default false;\n\n    ResponseHeader&#91;] responseHeaders() default @ResponseHeader(name = \"\", response = Void.class);\n\n    int code() default 200;\n\n    Extension&#91;] extensions() default @Extension(properties = @ExtensionProperty(name = \"\", value = \"\"));\n\n    boolean ignoreJsonView() default false;\n}\n<\/code><\/pre>\n","raw":"","protected":false},"excerpt":{"rendered":"<p>@Api \u6b64\u6ce8\u89e3\u5e94\u7528\u4e8e\u7c7b\u3001\u63a5\u53e3\u6216\u8005\u679a\u4e3e\u4e0a\uff0c\u542f\u52a8\u5e94\u7528\u65f6\u88ab\u6807\u6ce8\u7684\u7c7b\u4f1a\u626b\u63cf\u5230 swagger \u6e90\u4e2d\u3002\u9ed8\u8ba4\u60c5\u51b5\u4e0b\uff0cswagger \u6838\u5fc3\u4ec5\u626b &#8230;<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"emotion":"","emotion_color":"","title_style":"","license":"","footnotes":""},"categories":[2,7],"tags":[],"class_list":["post-3767","post","type-post","status-publish","format-standard","hentry","category-java","category-spring-boot"],"post_thumbnail_image":"https:\/\/wp-moto-1258805347.cos.ap-shanghai.myqcloud.com\/2024\/03\/20240302031711507.png","content_first_image":"https:\/\/wp-moto-1258805347.cos.ap-shanghai.myqcloud.com\/2024\/03\/20240302031711507.png","post_medium_image_300":"https:\/\/wp-moto-1258805347.cos.ap-shanghai.myqcloud.com\/2024\/03\/20240302031711507.png","post_thumbnail_image_624":"https:\/\/wp-moto-1258805347.cos.ap-shanghai.myqcloud.com\/2024\/03\/20240302031711507.png","post_frist_image":"https:\/\/wp-moto-1258805347.cos.ap-shanghai.myqcloud.com\/2024\/03\/20240302031711507.png","post_medium_image":"https:\/\/wp-moto-1258805347.cos.ap-shanghai.myqcloud.com\/2024\/03\/20240302031711507.png","post_large_image":"https:\/\/wp-moto-1258805347.cos.ap-shanghai.myqcloud.com\/2024\/03\/20240302031711507.png","post_full_image":"https:\/\/wp-moto-1258805347.cos.ap-shanghai.myqcloud.com\/2024\/03\/20240302031711507.png","post_all_images":[{"imagesurl":"https:\/\/wp-moto-1258805347.cos.ap-shanghai.myqcloud.com\/2024\/03\/20240302031711507-1024x473.png","id":"image0"},{"imagesurl":"https:\/\/wp-moto-1258805347.cos.ap-shanghai.myqcloud.com\/2024\/03\/20240302031711507-1024x473.png","id":"image1"}],"videoAdId":"","listAd":"0","listAdId":"","listAdEvery":6,"total_comments":0,"category_name":"Java","post_date":"2024-04-09","like_count":"0","praiseWord":"\u9f13\u52b1","copyright_state":"","excitationAd":"0","rewardedVideoAdId":"","detailAdId":"","detailAd":"0","enterpriseMinapp":"0","audios":[],"postImageUrl":"https:\/\/wp-moto-1258805347.cos.ap-shanghai.myqcloud.com\/2023\/05\/20230519082947553.jpg","avatarurls":[],"related_posts":null,"pageviews":788,"next_post_id":4279,"next_post_title":"Spring Boot\u6574\u5408Dubbo+ZooKeeper","previous_post_id":4194,"previous_post_title":"Spring Boot\u5f15\u5165\u5916\u90e8jar\u5305\u5e76\u6253\u5305","_links":{"self":[{"href":"https:\/\/xinchewhd.com.cn\/index.php\/wp-json\/wp\/v2\/posts\/3767","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/xinchewhd.com.cn\/index.php\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/xinchewhd.com.cn\/index.php\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/xinchewhd.com.cn\/index.php\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/xinchewhd.com.cn\/index.php\/wp-json\/wp\/v2\/comments?post=3767"}],"version-history":[{"count":2,"href":"https:\/\/xinchewhd.com.cn\/index.php\/wp-json\/wp\/v2\/posts\/3767\/revisions"}],"predecessor-version":[{"id":3771,"href":"https:\/\/xinchewhd.com.cn\/index.php\/wp-json\/wp\/v2\/posts\/3767\/revisions\/3771"}],"wp:attachment":[{"href":"https:\/\/xinchewhd.com.cn\/index.php\/wp-json\/wp\/v2\/media?parent=3767"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/xinchewhd.com.cn\/index.php\/wp-json\/wp\/v2\/categories?post=3767"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/xinchewhd.com.cn\/index.php\/wp-json\/wp\/v2\/tags?post=3767"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}