{"id":101,"date":"2024-11-01T21:52:05","date_gmt":"2024-11-01T13:52:05","guid":{"rendered":"https:\/\/rrt01.cn\/?p=101"},"modified":"2024-11-01T21:52:59","modified_gmt":"2024-11-01T13:52:59","slug":"swagger%e7%9a%84%e4%bd%bf%e7%94%a8","status":"publish","type":"post","link":"https:\/\/rrt01.cn\/?p=101","title":{"rendered":"Swagger\u7684\u4f7f\u7528"},"content":{"rendered":"<div id=\"ez-toc-container\" class=\"ez-toc-v2_0_68_1 counter-hierarchy ez-toc-counter ez-toc-grey ez-toc-container-direction\">\n<div class=\"ez-toc-title-container\">\n<p class=\"ez-toc-title \" >Table of Contents<\/p>\n<span class=\"ez-toc-title-toggle\"><a href=\"#\" class=\"ez-toc-pull-right ez-toc-btn ez-toc-btn-xs ez-toc-btn-default ez-toc-toggle\" aria-label=\"Toggle Table of Content\"><span class=\"ez-toc-js-icon-con\"><span class=\"\"><span class=\"eztoc-hide\" style=\"display:none;\">Toggle<\/span><span class=\"ez-toc-icon-toggle-span\"><svg style=\"fill: #999;color:#999\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" class=\"list-377408\" width=\"20px\" height=\"20px\" viewBox=\"0 0 24 24\" fill=\"none\"><path d=\"M6 6H4v2h2V6zm14 0H8v2h12V6zM4 11h2v2H4v-2zm16 0H8v2h12v-2zM4 16h2v2H4v-2zm16 0H8v2h12v-2z\" fill=\"currentColor\"><\/path><\/svg><svg style=\"fill: #999;color:#999\" class=\"arrow-unsorted-368013\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" width=\"10px\" height=\"10px\" viewBox=\"0 0 24 24\" version=\"1.2\" baseProfile=\"tiny\"><path d=\"M18.2 9.3l-6.2-6.3-6.2 6.3c-.2.2-.3.4-.3.7s.1.5.3.7c.2.2.4.3.7.3h11c.3 0 .5-.1.7-.3.2-.2.3-.5.3-.7s-.1-.5-.3-.7zM5.8 14.7l6.2 6.3 6.2-6.3c.2-.2.3-.5.3-.7s-.1-.5-.3-.7c-.2-.2-.4-.3-.7-.3h-11c-.3 0-.5.1-.7.3-.2.2-.3.5-.3.7s.1.5.3.7z\"\/><\/svg><\/span><\/span><\/span><\/a><\/span><\/div>\n<nav><ul class='ez-toc-list ez-toc-list-level-1 ' ><li class='ez-toc-page-1 ez-toc-heading-level-2'><a class=\"ez-toc-link ez-toc-heading-1\" href=\"https:\/\/rrt01.cn\/?p=101\/#%E4%B8%80%E3%80%81%E7%AE%80%E4%BB%8B\" title=\"\u4e00\u3001\u7b80\u4ecb\">\u4e00\u3001\u7b80\u4ecb<\/a><\/li><li class='ez-toc-page-1 ez-toc-heading-level-2'><a class=\"ez-toc-link ez-toc-heading-2\" href=\"https:\/\/rrt01.cn\/?p=101\/#%E4%BA%8C%E3%80%81%E5%9F%BA%E6%9C%AC%E4%BD%BF%E7%94%A8\" title=\"\u4e8c\u3001\u57fa\u672c\u4f7f\u7528\">\u4e8c\u3001\u57fa\u672c\u4f7f\u7528<\/a><ul class='ez-toc-list-level-3' ><li class='ez-toc-heading-level-3'><a class=\"ez-toc-link ez-toc-heading-3\" href=\"https:\/\/rrt01.cn\/?p=101\/#1_%E5%AF%BC%E5%85%A5%E7%9B%B8%E5%85%B3%E4%BE%9D%E8%B5%96\" title=\"1. \u5bfc\u5165\u76f8\u5173\u4f9d\u8d56\">1. \u5bfc\u5165\u76f8\u5173\u4f9d\u8d56<\/a><\/li><li class='ez-toc-page-1 ez-toc-heading-level-3'><a class=\"ez-toc-link ez-toc-heading-4\" href=\"https:\/\/rrt01.cn\/?p=101\/#2_%E7%BC%96%E5%86%99%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6\" title=\"2. \u7f16\u5199\u914d\u7f6e\u6587\u4ef6\">2. \u7f16\u5199\u914d\u7f6e\u6587\u4ef6<\/a><\/li><li class='ez-toc-page-1 ez-toc-heading-level-3'><a class=\"ez-toc-link ez-toc-heading-5\" href=\"https:\/\/rrt01.cn\/?p=101\/#3_%E6%8E%A7%E5%88%B6Swagger%E7%9A%84%E5%BC%80%E5%90%AF\" title=\"3. \u63a7\u5236Swagger\u7684\u5f00\u542f\">3. \u63a7\u5236Swagger\u7684\u5f00\u542f<\/a><\/li><li class='ez-toc-page-1 ez-toc-heading-level-3'><a class=\"ez-toc-link ez-toc-heading-6\" href=\"https:\/\/rrt01.cn\/?p=101\/#4_%E5%B8%B8%E7%94%A8%E6%B3%A8%E8%A7%A3%E7%9A%84%E4%BD%BF%E7%94%A8\" title=\"4. \u5e38\u7528\u6ce8\u89e3\u7684\u4f7f\u7528\">4. \u5e38\u7528\u6ce8\u89e3\u7684\u4f7f\u7528<\/a><\/li><li class='ez-toc-page-1 ez-toc-heading-level-3'><a class=\"ez-toc-link ez-toc-heading-7\" href=\"https:\/\/rrt01.cn\/?p=101\/#5_%E6%B7%BB%E5%8A%A0%E8%AF%B7%E6%B1%82%E5%A4%B4\" title=\"5. \u6dfb\u52a0\u8bf7\u6c42\u5934\">5. \u6dfb\u52a0\u8bf7\u6c42\u5934<\/a><\/li><\/ul><\/li><li class='ez-toc-page-1 ez-toc-heading-level-2'><a class=\"ez-toc-link ez-toc-heading-8\" href=\"https:\/\/rrt01.cn\/?p=101\/#%E4%B8%89%E3%80%81Swagger%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6\" title=\"\u4e09\u3001Swagger\u914d\u7f6e\u6587\u4ef6\">\u4e09\u3001Swagger\u914d\u7f6e\u6587\u4ef6<\/a><\/li><\/ul><\/nav><\/div>\n<h2><span class=\"ez-toc-section\" id=\"%E4%B8%80%E3%80%81%E7%AE%80%E4%BB%8B\"><\/span>\u4e00\u3001\u7b80\u4ecb<span class=\"ez-toc-section-end\"><\/span><\/h2>\n<p>\u5b98\u7f51\uff1a<a href=\"https:\/\/swagger.io\/\">https:\/\/swagger.io\/<\/a><\/p>\n<p>Swagger\u7528\u4e8e\u751f\u6210\u3001\u63cf\u8ff0\u3001\u8c03\u7528\u548c\u53ef\u89c6\u5316Restful\u98ce\u683c\u7684Web\u670d\u52a1\u3002Swagger\u7684\u76ee\u6807\u662f\u5bf9REST API\u5b9a\u4e49\u4e00\u4e2a\u6807\u51c6\u4e14\u548c\u8bed\u8a00\u65e0\u5173\u7684\u63a5\u53e3\uff0c\u53ef\u4ee5\u8ba9\u4eba\u548c\u8ba1\u7b97\u673a\u62e5\u6709\u65e0\u987b\u8bbf\u95ee\u6e90\u7801\u3001\u6587\u6863\u548c\u7f51\u7edc\u6d41\u91cf\u76d1\u6d4b\u5c31\u53ef\u4ee5\u53d1\u73b0\u548c\u7406\u89e3\u670d\u52a1\u7684\u80fd\u529b\u3002<\/p>\n<p>\u4f18\u52bf\uff1a<\/p>\n<ul>\n<li>\u652f\u6301API\u81ea\u52a8\u751f\u6210\u540c\u6b65\u5728\u7ebf\u6587\u6863\uff1a\u4f7f\u7528Swagger\u53ef\u4ee5\u76f4\u63a5\u901a\u8fc7\u4ee3\u7801\u751f\u6210\u6587\u6863\uff0c\u4e0d\u9700\u8981\u81ea\u5df1\u624b\u52a8\u7f16\u5199\u5728\u7ebf\u6587\u6863\u3002<\/li>\n<li>\u63d0\u4f9bWeb\u9875\u9762\u5728\u7ebf\u6d4b\u8bd5API<\/li>\n<\/ul>\n<h2><span class=\"ez-toc-section\" id=\"%E4%BA%8C%E3%80%81%E5%9F%BA%E6%9C%AC%E4%BD%BF%E7%94%A8\"><\/span>\u4e8c\u3001\u57fa\u672c\u4f7f\u7528<span class=\"ez-toc-section-end\"><\/span><\/h2>\n<h3><span class=\"ez-toc-section\" id=\"1_%E5%AF%BC%E5%85%A5%E7%9B%B8%E5%85%B3%E4%BE%9D%E8%B5%96\"><\/span>1. \u5bfc\u5165\u76f8\u5173\u4f9d\u8d56<span class=\"ez-toc-section-end\"><\/span><\/h3>\n<pre><code class=\"language-java\">        &lt;!-- swagger --&gt;\n        &lt;dependency&gt;\n            &lt;groupId&gt;io.springfox&lt;\/groupId&gt;\n            &lt;artifactId&gt;springfox-spring-web&lt;\/artifactId&gt;\n            &lt;version&gt;2.9.2&lt;\/version&gt;\n        &lt;\/dependency&gt;\n        &lt;dependency&gt;\n            &lt;groupId&gt;io.springfox&lt;\/groupId&gt;\n            &lt;artifactId&gt;springfox-swagger2&lt;\/artifactId&gt;\n            &lt;version&gt;2.9.2&lt;\/version&gt;\n        &lt;\/dependency&gt;\n        &lt;dependency&gt;\n            &lt;groupId&gt;io.springfox&lt;\/groupId&gt;\n            &lt;artifactId&gt;springfox-swagger-ui&lt;\/artifactId&gt;\n            &lt;version&gt;2.9.2&lt;\/version&gt;\n        &lt;\/dependency&gt;<\/code><\/pre>\n<h3><span class=\"ez-toc-section\" id=\"2_%E7%BC%96%E5%86%99%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6\"><\/span>2. \u7f16\u5199\u914d\u7f6e\u6587\u4ef6<span class=\"ez-toc-section-end\"><\/span><\/h3>\n<p>\u5728\u914d\u7f6e\u6587\u4ef6<code>config<\/code>\u76ee\u5f55\u4e0b\uff0c\u6dfb\u52a0Swagger\u7684\u914d\u7f6e\u6587\u4ef6<code>SwaggerConfig.java<\/code><\/p>\n<pre><code class=\"language-java\">@Configuration \/\/ \u914d\u7f6e\u7c7b\n@EnableSwagger2 \/\/ \u5f00\u542f swagger2 \u7684\u81ea\u52a8\u914d\u7f6e\npublic class SwaggerConfig {}<\/code><\/pre>\n<p>\u6b64\u65f6Swagger\u5df2\u7ecf\u6574\u5408\u5230\u9879\u76ee\u4e4b\u4e2d\uff0c\u53ef\u4ee5\u542f\u52a8\u670d\u52a1\u3002\u901a\u8fc7\u8f93\u5165<code>http:\/\/localhost:8080\/swagger-ui.html#<\/code>\u53ef\u4ee5\u67e5\u770bswagger\u6587\u6863\u3002<\/p>\n<p><img decoding=\"async\" src=\"C:\\Users\\13638\\AppData\\Roaming\\Typora\\typora-user-images\\image-20240826101342101.png\" alt=\"image-20240826101342101\" \/><\/p>\n<p>\u5b9e\u4f53\u7c7b\u4fe1\u606f\u4f1a\u5305\u542b\u63a5\u53e3\u8bf7\u6c42\u6216\u8005\u76f8\u5e94\u7684\u5b9e\u4f53\u7c7b\u4fe1\u606f\u3002<\/p>\n<p><strong>2.1 \u914d\u7f6e\u57fa\u672c\u4fe1\u606f<\/strong><\/p>\n<p>Swagger\u6709\u81ea\u5df1\u7684\u5b9e\u4f8bDocket\uff0c\u5982\u679c\u8981\u81ea\u5b9a\u4e49\u57fa\u672c\u4fe1\u606f\u53ef\u4ee5\u4f7f\u7528docket\u914d\u7f6eswagger\uff0c\u57fa\u672c\u4fe1\u606f\u7684\u8bbe\u7f6e\u5728<code>ApiInfo<\/code>\u8fd9\u4e2a\u5bf9\u8c61\u4e2d\u3002<\/p>\n<p><code>SwaggerConfig.java<\/code>\u914d\u7f6e\u6587\u4ef6\u6dfb\u52a0\u4ee5\u4e0b\u5185\u5bb9<\/p>\n<pre><code class=\"language-java\">    @Bean\n    public Docket docket() {\n\n        \/\/ \u521b\u5efa\u4e00\u4e2a swagger \u7684 bean \u5b9e\u4f8b\n        return new Docket(DocumentationType.SWAGGER_2)\n                \/\/ \u914d\u7f6e\u57fa\u672c\u4fe1\u606f\n                .apiInfo(apiInfo());\n    }\n\n    \/\/ \u914d\u7f6e\u57fa\u672c\u4fe1\u606f\n    private ApiInfo apiInfo() {\n        Contact contact = new Contact(\n                &quot;TRR&quot;, \/\/ \u4f5c\u8005\u59d3\u540d\n                &quot;https:\/\/rrt01.cn&quot;, \/\/ \u4f5c\u8005\u7f51\u7ad9\n                &quot;11111111@qq.com&quot;); \/\/ \u90ae\u7bb1\n        return new ApiInfoBuilder()\n                .title(&quot;aaa-\u63a5\u53e3\u6587\u6863&quot;) \/\/ \u6807\u9898\n                .description(&quot;\u9ed1\u6697\u4e2d\u7684\u4e00\u70b9\u5149&quot;) \/\/ \u63cf\u8ff0\n                .termsOfServiceUrl(&quot;https:\/\/www.baidu.com&quot;) \/\/\u8df3\u8f6c\u94fe\u63a5\n                .version(&quot;1.0&quot;) \/\/ \u7248\u672c\n                .license(&quot;Swagger\u6559\u7a0b&quot;)\n                .licenseUrl(&quot;https:\/\/rrt01.cn&quot;)\n                .contact(contact)\n                .build();\n    }<\/code><\/pre>\n<p><strong>2.2 \u914d\u7f6e\u63a5\u53e3\u4fe1\u606f<\/strong><\/p>\n<p>\u9ed8\u8ba4\u60c5\u51b5\u4e0b\uff0cSwagger\u4f1a\u5c55\u793a\u6240\u6709\u63a5\u53e3\u4fe1\u606f\u3002\u5982\u679c\u5e0c\u671b\u53ea\u663e\u793a\u67d0\u4e9b\u7279\u5b9a\u63a5\u53e3\uff0c\u53ef\u4ee5\u901a\u8fc7\u626b\u63cf\u63a5\u53e3\u6765\u5b9e\u73b0\u3002<\/p>\n<pre><code class=\"language-java\">    @Bean\n    public Docket docket() {\n\n        \/\/ \u521b\u5efa\u4e00\u4e2a swagger \u7684 bean \u5b9e\u4f8b\n        return new Docket(DocumentationType.SWAGGER_2)\n                \/\/ \u914d\u7f6e\u63a5\u53e3\u4fe1\u606f\n                .select() \/\/\u8bbe\u7f6e\u626b\u63cf\u63a5\u53e3\n                \/\/ \u914d\u7f6e\u5982\u4f55\u626b\u63cf\u63a5\u53e3\n                .apis(RequestHandlerSelectors\n                        \/\/.any() \/\/ \u626b\u63cf\u5168\u90e8\u7684\u63a5\u53e3\uff0c\u9ed8\u8ba4\n                        \/\/.none() \/\/ \u5168\u90e8\u4e0d\u626b\u63cf\n                        .basePackage(&quot;com.example.demo0.demos.controller&quot;) \/\/ \u626b\u63cf\u6307\u5b9a\u5305\u4e0b\u7684\u63a5\u53e3\uff0c\u6700\u4e3a\u5e38\u7528\n                        \/\/.withClassAnnotation(RestController.class) \/\/ \u626b\u63cf\u5e26\u6709\u6307\u5b9a\u6ce8\u89e3\u7684\u7c7b\u4e0b\u6240\u6709\u63a5\u53e3\n                        \/\/.withMethodAnnotation(PostMapping.class) \/\/ \u626b\u63cf\u5e26\u6709\u53ea\u5f53\u6ce8\u89e3\u7684\u65b9\u6cd5\u63a5\u53e3\n                )\n                .paths(PathSelectors\n                        .any() \/\/ \u6ee1\u8db3\u6761\u4ef6\u7684\u8def\u5f84\uff0c\u8be5\u65ad\u8a00\u603b\u4e3atrue\n                        \/\/.none() \/\/ \u4e0d\u6ee1\u8db3\u6761\u4ef6\u7684\u8def\u5f84\uff0c\u8be5\u65ad\u8a00\u603b\u4e3afalse\uff08\u53ef\u7528\u4e8e\u751f\u6210\u73af\u5883\u5c4f\u853d swagger\uff09\n                        \/\/.ant(&quot;\/user\/**&quot;) \/\/ \u6ee1\u8db3\u5b57\u7b26\u4e32\u8868\u8fbe\u5f0f\u8def\u5f84\n                        \/\/.regex(&quot;&quot;) \/\/ \u7b26\u5408\u6b63\u5219\u7684\u8def\u5f84\n                )\n                .build();\n    }<\/code><\/pre>\n<p><strong>2.3 \u914d\u7f6e\u5206\u7ec4\u4fe1\u606f<\/strong><\/p>\n<p>Swagger\u9ed8\u8ba4\u53ea\u6709\u4e00\u4e2a<code>default<\/code>\u5206\u7ec4\u9009\u9879\uff0c\u5982\u679c\u6ca1\u6709\u8bbe\u7f6e\u5206\u7ec4\uff0c\u6240\u6709\u63a5\u53e3\u90fd\u4f1a\u663e\u793a\u5728<code>default<\/code>\u5206\u7ec4\u4e0b\u3002\u5982\u679c\u60f3\u8bbe\u7f6e\u5206\u7ec4\u540d\u79f0\uff0c\u53ef\u4ee5\u901a\u8fc7<code>.groupName(String )<\/code>\u8bbe\u7f6e\u3002<\/p>\n<pre><code class=\"language-java\">    @Bean\n    public Docket docket() {\n        \/\/ \u521b\u5efa\u4e00\u4e2a swagger \u7684 bean \u5b9e\u4f8b\n        return new Docket(DocumentationType.SWAGGER_2)\n\n                \/\/ \u7ec4\u540d\n                .groupName(&quot;test&quot;);               \n    }<\/code><\/pre>\n<p>\u5982\u679c\u9700\u8981\u914d\u7f6e\u591a\u4e2a\u7ec4\u7684\u8bdd\uff0c\u9700\u8981\u914d\u7f6e\u591a\u4e2a<code>docket()<\/code>\u65b9\u6cd5\u3002<\/p>\n<pre><code class=\"language-java\">    @Bean\n    public Docket docket1() {\n        \/\/ \u521b\u5efa\u4e00\u4e2a swagger \u7684 bean \u5b9e\u4f8b\n        return new Docket(DocumentationType.SWAGGER_2)\n\n                \/\/ \u7ec4\u540d\n                .groupName(&quot;test1&quot;);               \n    }\n\n    @Bean\n    public Docket docket2() {\n        \/\/ \u521b\u5efa\u4e00\u4e2a swagger \u7684 bean \u5b9e\u4f8b\n        return new Docket(DocumentationType.SWAGGER_2)\n\n                \/\/ \u7ec4\u540d\n                .groupName(&quot;test2&quot;);               \n    }<\/code><\/pre>\n<h3><span class=\"ez-toc-section\" id=\"3_%E6%8E%A7%E5%88%B6Swagger%E7%9A%84%E5%BC%80%E5%90%AF\"><\/span>3. \u63a7\u5236<code>Swagger<\/code>\u7684\u5f00\u542f<span class=\"ez-toc-section-end\"><\/span><\/h3>\n<p>\u4e0d\u662f\u4efb\u4f55\u73af\u5883\u4e0b\u90fd\u9002\u5408\u5f00\u542fswagger\uff0c\u5982\u679c\u5728\u751f\u4ea7\u73af\u5883\u4e0b\u5f00\u542f\u7684\u8bdd\uff0c\u63a5\u53e3\u5c06\u4f1a\u66b4\u9732\u51fa\u6765\uff0c\u5177\u6709\u6781\u5927\u7684\u98ce\u9669\uff0c\u56e0\u6b64\uff0c\u8ba9swagger\u6839\u636e\u4e0d\u540c\u7684\u73af\u5883\u5f00\u542f\u4e5f\u5f88\u91cd\u8981\u3002\u901a\u8fc7\u9879\u76ee\u7684\u914d\u7f6e\u6587\u4ef6\u53ef\u4ee5\u6307\u5b9a\u9009\u62e9\u7684\u73af\u5883\u3002<code>application.yml<\/code>\u5185\u5bb9\u5982\u4e0b<\/p>\n<pre><code class=\"language-yml\">spring:\n  profiles:\n    active: dev<\/code><\/pre>\n<p>\u7136\u540e\u53ef\u4ee5\u901a\u8fc7\u4ee3\u7801\u5224\u65ad\u6b64\u65f6\u662f\u5728\u4ec0\u4e48\u73af\u5883\uff0c\u5982\u679c\u5728<code>pro<\/code>\u73af\u5883\uff0c\u5219\u5173\u95ed<code>swagger<\/code><\/p>\n<pre><code class=\"language-java\">    \/***\n     * swagger\u914d\u7f6e\n     * @param environment\n     * @return\n     *\/\n    @Bean\n    public Docket docket(Environment environment) {\n\n        \/\/ \u8bbe\u7f6e\u73af\u5883\u8303\u56f4\n        Profiles profiles = Profiles.of(&quot;dev&quot;, &quot;test&quot;);\n        \/\/ \u5982\u679c\u5728\u8be5\u73af\u5883\u8fd4\u56de\u5185\u5219\u8fd4\u56de: true\uff0c\u53cd\u4e4b\u8fd4\u56de: false\n        boolean flag = environment.acceptsProfiles(profiles);\n\n        \/\/ \u521b\u5efa\u4e00\u4e2a swagger \u7684 bean \u5b9e\u4f8b\n        return new Docket(DocumentationType.SWAGGER_2)\n\n                \/\/ \u662f\u5426\u5f00\u542fswagger\n                .enable(flag);\n\n    }<\/code><\/pre>\n<p>\u5982\u679c<code>application.yml<\/code>\u5168\u5c40\u914d\u7f6e\u6587\u4ef6\u4e2d\u73af\u5883\u6307\u5411<code>pro<\/code>\u65f6\uff0c\u4fbf\u4f1a\u63d0\u793a<code>Could not render e, see the console<\/code>\u3002<\/p>\n<h3><span class=\"ez-toc-section\" id=\"4_%E5%B8%B8%E7%94%A8%E6%B3%A8%E8%A7%A3%E7%9A%84%E4%BD%BF%E7%94%A8\"><\/span>4. \u5e38\u7528\u6ce8\u89e3\u7684\u4f7f\u7528<span class=\"ez-toc-section-end\"><\/span><\/h3>\n<p><strong><code>@ApiModel<\/code><\/strong><\/p>\n<p>\u8be5\u6ce8\u89e3\u662f\u4f5c\u7528\u4e8e\u7c7b\u4e0a\u9762\u7684\uff0c\u7528\u6765\u63cf\u8ff0\u7c7b\u7684\u4e00\u4e9b\u57fa\u672c\u4fe1\u606f\u3002<\/p>\n<p>\u76f8\u5173\u5c5e\u6027<\/p>\n<ul>\n<li><code>value<\/code>\uff1a\u63d0\u4f9b\u7c7b\u7684\u4e00\u4e2a\u5907\u7528\u540d\uff0c\u5982\u679c\u4e0d\u8bbe\u7f6e\uff0c\u9ed8\u8ba4\u60c5\u51b5\u4e0b\u5c06\u4f7f\u7528 class \u7c7b\u7684\u540d\u79f0<\/li>\n<li><code>description<\/code>\uff1a\u5bf9\u4e8e\u7c7b\uff0c\u63d0\u4f9b\u4e00\u4e2a\u8be6\u7ec6\u7684\u63cf\u8ff0\u4fe1\u606f<\/li>\n<li><code>parent<\/code>\uff1a\u8fd9\u4e2a\u5c5e\u6027\u7528\u4e8e\u63cf\u8ff0\u7684\u662f\u7c7b\u7684\u4e00\u4e9b\u7236\u7c7b\u4fe1\u606f<\/li>\n<li><code>discriminator<\/code>\uff1a\u8fd9\u4e2a\u5c5e\u6027\u89e3\u91ca\u8d77\u6765\u6bd4\u8f83\u9ebb\u70e6\uff0c\u56e0\u4e3a\u8fd9\u4e2a\u7c7b\u4e3b\u8981\u4f53\u73b0\u5728\u65ad\u8a00\u5f53\u4e2d<\/li>\n<li><code>subTypes<\/code>\uff1a\u53ef\u4ee5\u901a\u8fc7\u8fd9\u4e2a\u5c5e\u6027\uff0c\u6307\u5b9a\u6211\u4eec\u60f3\u8981\u4f7f\u7528\u7684\u5b50\u7c7b<\/li>\n<\/ul>\n<p><strong><code>@ApiModelProperty<\/code><\/strong><\/p>\n<p>\u8be5\u6ce8\u89e3\u7528\u4e8e\u6dfb\u52a0\u548c\u64cd\u4f5c\u5c5e\u6027\u6a21\u5757\u7684\u6570\u636e<\/p>\n<p>\u76f8\u5173\u5c5e\u6027<\/p>\n<ul>\n<li><code>value()<\/code>\uff1a\u53c2\u6570\u7c7b\u578b\u4e3aString\uff0c\u4e3a\u5c5e\u6027\u7684\u7b80\u8981\u8bf4\u660e<\/li>\n<li><code>name()<\/code>\uff1a\u5141\u8bb8\u91cd\u5199\u5c5e\u6027\u7684\u540d\u79f0<\/li>\n<li><code>allowableValues()<\/code>\uff1a\u5141\u8bb8\u6b64\u53c2\u6570\u5b58\u50a8\u7684\u957f\u5ea6<\/li>\n<li><code>access()<\/code>\uff1a\u5141\u8bb8\u4ece API \u6587\u4ef6\u4e2d\u8fc7\u6ee4\u5c5e\u6027<\/li>\n<li><code>notes()<\/code>\uff1a\u8be5\u5b57\u6bb5\u7684\u6ce8\u91ca\u8bf4\u660e<\/li>\n<li><code>dataType()<\/code>\uff1a\u53c2\u6570\u7684\u6570\u636e\u7c7b\u578b<\/li>\n<li><code>required()<\/code>\uff1a\u6307\u5b9a\u53c2\u6570\u662f\u5426\u53ef\u4ee5\u4e3a\u7a7a\uff0c\u9ed8\u8ba4\u4e3a<code>false<\/code>\uff1b\u53c2\u6570\u7c7b\u578b<code>boolean<\/code><\/li>\n<li><code>position()<\/code>\uff1a\u5141\u8bb8\u663e\u793a\u5730\u5bf9\u6a21\u578b\u4e2d\u5730\u5c5e\u6027\u6392\u5e8f\uff1b\u53c2\u6570\u7c7b\u578b<code>int<\/code><\/li>\n<li><code>hidden()<\/code>\uff1a\u662f\u5426\u5141\u8bb8\u6a21\u578b\u5c5e\u6027\u9690\u85cf\u5728Swagger\u6a21\u578b\u5b9a\u4e49\u4e2d\uff0c\u9ed8\u8ba4\u4e3a<code>false<\/code>\uff1b\u53c2\u6570\u7c7b\u578b<code>boolean<\/code><\/li>\n<li><code>example()<\/code>\uff1a\u5c5e\u6027\u5730\u793a\u4f8b\u503c<\/li>\n<li><code>readOnly()<\/code>\uff1a\u662f\u5426\u5141\u8bb8\u5c06\u5c5e\u6027\u6307\u5b9a\u4e3a\u53ea\u8bfb\uff0c\u9ed8\u8ba4\u4e3a<code>false<\/code>\uff1b\u53c2\u6570\u7c7b\u578b<code>boolean<\/code><\/li>\n<li><code>reference()<\/code>\uff1a\u6307\u5b9a\u5bf9\u5bf9\u5e94\u7c7b\u578b\u5b9a\u4e49\u7684\u5f15\u7528\uff0c\u91cd\u5199\u6307\u5b9a\u7684\u4efb\u4f55\u5176\u4ed6\u6570\u636e\u540d\u79f0<\/li>\n<li><code>allowEmptyValue()<\/code>\uff1a\u662f\u5426\u5141\u8bb8\u4f20\u9012\u7a7a\u503c\uff0c\u9ed8\u8ba4\u4e3a<code>false<\/code>\uff1b\u53c2\u6570\u7c7b\u578b<code>boolean<\/code><\/li>\n<\/ul>\n<p>\u793a\u4f8b<\/p>\n<pre><code class=\"language-java\">  @ApiModelProperty(value = &quot;\u4e3b\u952e&quot;,name = &quot;id&quot;,\n      allowableValues = &quot;32&quot;,\n      access = &quot;1&quot;,\n      notes = &quot;\u7528\u6237\u7684id&quot;,\n      dataType = &quot;int&quot;,\n      required = false,\n      position = 1,\n      hidden = true,\n      example = &quot;1&quot;,\n      readOnly = false,\n      reference = &quot;id&quot;,\n      allowEmptyValue = false)\n  @TableId(value = &quot;id&quot;,type = IdType.AUTO)\n  private int id;\n<\/code><\/pre>\n<p><strong><code>@ApiOperation<\/code><\/strong><\/p>\n<p>\u8be5\u6ce8\u89e3\u7528\u6765\u5bf9\u67d0\u65b9\u6cd5\/\u63a5\u53e3\u8fdb\u884c\u63cf\u8ff0<\/p>\n<pre><code class=\"language-java\">    @PostMapping(value = &quot;\/info&quot;)\n    @ApiOperation(value = &quot;\u6839\u636eid\u67e5\u8be2\u7528\u6237\u8be6\u60c5&quot;)\n    public ResponseBean queryUserInfo(@RequestBody @Validated IdReq req) {\n        return ResponseBean.success(userService.queryUserInfo(req));\n    }<\/code><\/pre>\n<p><strong><code>@ApiParam<\/code><\/strong><\/p>\n<p>\u8be5\u6ce8\u89e3\u4f7f\u7528\u5728\u65b9\u6cd5\u6216\u53c2\u6570\u4e0a\uff0c\u8fdb\u884c\u5b57\u6bb5\u8bf4\u660e\uff0c\u662f\u5426\u6dfb\u52a0\u5143\u6570\u636e\u7b49<\/p>\n<p>\u76f8\u5173\u5c5e\u6027<\/p>\n<ul>\n<li>name\uff1a\u53c2\u6570\u540d<\/li>\n<li>value\uff1a\u53c2\u6570\u8bf4\u660e<\/li>\n<li>required\uff1a\u662f\u5426\u5fc5\u586b<\/li>\n<\/ul>\n<pre><code class=\"language-java\">    @PostMapping(value = &quot;\/query-user-infos&quot;)\n    @ApiOperation(value = &quot;\u6761\u4ef6\u67e5\u8be2\u7528\u6237\u4fe1\u606f&quot;)\n    public ResponseBean queryUserInfos(\n            \/\/ name \u7528\u6237\u540d\u79f0 \u4e0d\u5fc5\u586b\n            @ApiParam(value = &quot;\u7528\u6237\u540d\u79f0&quot;, required = false) @RequestParam(required = false) String name,\n            \/\/ gender \u7528\u6237\u6027\u522b \u5fc5\u586b\n            @ApiParam(value = &quot;\u7528\u6237\u6027\u522b&quot;, required = true) @RequestParam(required = true) GenderEnum gender\n    ) {\n        return ResponseBean.success(userService.queryUserInfos(name,gender));\n    }<\/code><\/pre>\n<h3><span class=\"ez-toc-section\" id=\"5_%E6%B7%BB%E5%8A%A0%E8%AF%B7%E6%B1%82%E5%A4%B4\"><\/span>5. \u6dfb\u52a0\u8bf7\u6c42\u5934<span class=\"ez-toc-section-end\"><\/span><\/h3>\n<p>\u5982\u679c\u63a5\u53e3\u9700\u8981\u83b7\u53d6\u8bf7\u6c42\u5934\u4fe1\u606f\uff0c\u5219\u9700\u8981\u5728swagger\u914d\u7f6e\u4e2d\u6dfb\u52a0\u8bf7\u6c42\u5934\u7684\u914d\u7f6e<\/p>\n<pre><code class=\"language-java\">    @Bean\n    public Docket docket() {\n        \/\/ \u8bbe\u7f6e\u8bf7\u6c42\u5934\n        List&lt;Parameter&gt; parameters = new ArrayList&lt;&gt;();\n        parameters.add(new ParameterBuilder()\n                .name(&quot;token&quot;) \/\/ \u5b57\u6bb5\u540d\n                .description(&quot;token&quot;) \/\/ \u63cf\u8ff0\n                .modelRef(new ModelRef(&quot;string&quot;)) \/\/ \u6570\u636e\u7c7b\u578b\n                .parameterType(&quot;header&quot;) \/\/ \u53c2\u6570\u7c7b\u578b\n                .defaultValue(&quot;default value&quot;) \/\/ \u9ed8\u8ba4\u503c\uff1a\u53ef\u81ea\u5df1\u8bbe\u7f6e\n                .hidden(true) \/\/ \u662f\u5426\u9690\u85cf\n                .required(false) \/\/ \u662f\u5426\u5fc5\u987b\n                .build());\n\n        \/\/ \u521b\u5efa\u4e00\u4e2a swagger \u7684 bean \u5b9e\u4f8b\n        return new Docket(DocumentationType.SWAGGER_2)\n                .groupName(&quot;mike&quot;) \/\/ \u4fee\u6539\u7ec4\u540d\u4e3a &quot;mike&quot;\n                \/\/ \u914d\u7f6e\u63a5\u53e3\u4fe1\u606f\n                .select() \/\/ \u8bbe\u7f6e\u626b\u63cf\u63a5\u53e3\n                \/\/ \u914d\u7f6e\u5982\u4f55\u626b\u63cf\u63a5\u53e3\n                .apis(RequestHandlerSelectors\n                        .basePackage(&quot;com.example.demo0.demos.controller&quot;) \/\/ \u626b\u63cf\u6307\u5b9a\u5305\u4e0b\u7684\u63a5\u53e3\uff0c\u6700\u4e3a\u5e38\u7528\n                )\n                .paths(PathSelectors\n                        .any() \/\/ \u6ee1\u8db3\u6761\u4ef6\u7684\u8def\u5f84\uff0c\u8be5\u65ad\u8a00\u603b\u4e3atrue\n                )\n                .build()\n\n                \/\/ \u6dfb\u52a0\u8bf7\u6c42\u5934\u53c2\u6570\n                .globalOperationParameters(parameters);\n    }<\/code><\/pre>\n<p>\u63a5\u53e3\u5982\u4e0b<\/p>\n<pre><code class=\"language-java\">    @GetMapping(value = &quot;\/get-token&quot;)\n    @ApiOperation(value = &quot;\u83b7\u53d6\u8bf7\u6c42\u5934\u4e2d\u7684token\u4fe1\u606f&quot;)\n    public void getToken(\n            @RequestHeader(value = &quot;token&quot;,required = false) String token\n    ) {\n        \/\/ \u76f4\u63a5\u83b7\u53d6 token \u4fe1\u606f\n        System.out.println(&quot;token = &quot; + token);\n\n        \/\/ \u901a\u8fc7\u4ee3\u7801\u83b7\u53d6\n        ServletRequestAttributes servletRequestAttributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();\n        if (servletRequestAttributes != null) {\n            HttpServletRequest request = servletRequestAttributes.getRequest();\n            String header = request.getHeader(&quot;token&quot;);\n            System.err.println(&quot;header = &quot; + header);\n        }\n    }<\/code><\/pre>\n<p><img decoding=\"async\" src=\"https:\/\/i-blog.csdnimg.cn\/blog_migrate\/acdfc4497cef580429348abd99d516b6.png\" alt=\"\u5728\u8fd9\u91cc\u63d2\u5165\u56fe\u7247\u63cf\u8ff0\" \/><\/p>\n<h2><span class=\"ez-toc-section\" id=\"%E4%B8%89%E3%80%81Swagger%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6\"><\/span>\u4e09\u3001<code>Swagger<\/code>\u914d\u7f6e\u6587\u4ef6<span class=\"ez-toc-section-end\"><\/span><\/h2>\n<pre><code class=\"language-java\">package com.example.demo0.demos.conf;\n\nimport org.springframework.context.annotation.Bean;\nimport org.springframework.context.annotation.Configuration;\nimport org.springframework.core.env.Environment;\nimport org.springframework.core.env.Profiles;\nimport springfox.documentation.builders.ApiInfoBuilder;\nimport springfox.documentation.builders.ParameterBuilder;\nimport springfox.documentation.builders.PathSelectors;\nimport springfox.documentation.builders.RequestHandlerSelectors;\nimport springfox.documentation.schema.ModelRef;\nimport springfox.documentation.service.ApiInfo;\nimport springfox.documentation.service.Contact;\nimport springfox.documentation.service.Parameter;\nimport springfox.documentation.spi.DocumentationType;\nimport springfox.documentation.spring.web.plugins.Docket;\nimport springfox.documentation.swagger2.annotations.EnableSwagger2;\n\nimport java.util.ArrayList;\nimport java.util.List;\n\n@Configuration \/\/ \u914d\u7f6e\u7c7b\n@EnableSwagger2 \/\/ \u5f00\u542f swagger2 \u7684\u81ea\u52a8\u914d\u7f6e\npublic class SwaggerConfig {\n\n    \/***\n     * swagger\u914d\u7f6e\n     * @param environment\n     * @return\n     *\/\n    @Bean\n    public Docket docket(Environment environment) {\n\n        \/\/ \u8bbe\u7f6e\u73af\u5883\u8303\u56f4\n        Profiles profiles = Profiles.of(&quot;dev&quot;, &quot;test&quot;);\n        \/\/ \u5982\u679c\u5728\u8be5\u73af\u5883\u8fd4\u56de\u5185\u5219\u8fd4\u56de: true\uff0c\u53cd\u4e4b\u8fd4\u56de: false\n        boolean flag = environment.acceptsProfiles(profiles);\n\n        \/\/ \u8bbe\u7f6e\u8bf7\u6c42\u5934\n        List&lt;Parameter&gt; parameters = new ArrayList&lt;&gt;();\n        parameters.add(new ParameterBuilder()\n                .name(&quot;token&quot;) \/\/ \u5b57\u6bb5\u540d\n                .description(&quot;token&quot;) \/\/ \u63cf\u8ff0\n                .modelRef(new ModelRef(&quot;string&quot;)) \/\/ \u6570\u636e\u7c7b\u578b\n                .parameterType(&quot;header&quot;) \/\/ \u53c2\u6570\u7c7b\u578b\n                .defaultValue(&quot;default value&quot;) \/\/ \u9ed8\u8ba4\u503c\uff1a\u53ef\u81ea\u5df1\u8bbe\u7f6e\n                .hidden(true) \/\/ \u662f\u5426\u9690\u85cf\n                .required(false) \/\/ \u662f\u5426\u5fc5\u987b\n                .build());\n\n        \/\/ \u521b\u5efa\u4e00\u4e2a swagger \u7684 bean \u5b9e\u4f8b\n        return new Docket(DocumentationType.SWAGGER_2)\n                \/\/ \u914d\u7f6e\u57fa\u672c\u4fe1\u606f\n                .apiInfo(apiInfo())\n                \/\/ \u7ec4\u540d\n                .groupName(&quot;test&quot;)\n                \/\/ \u914d\u7f6e\u63a5\u53e3\u4fe1\u606f\n                .select() \/\/\u8bbe\u7f6e\u626b\u63cf\u63a5\u53e3\n                \/\/ \u914d\u7f6e\u5982\u4f55\u626b\u63cf\u63a5\u53e3\n                .apis(RequestHandlerSelectors\n                        \/\/.any() \/\/ \u626b\u63cf\u5168\u90e8\u7684\u63a5\u53e3\uff0c\u9ed8\u8ba4\n                        \/\/.none() \/\/ \u5168\u90e8\u4e0d\u626b\u63cf\n                        .basePackage(&quot;com.example.demo0.demos.controller&quot;) \/\/ \u626b\u63cf\u6307\u5b9a\u5305\u4e0b\u7684\u63a5\u53e3\uff0c\u6700\u4e3a\u5e38\u7528\n                        \/\/.withClassAnnotation(RestController.class) \/\/ \u626b\u63cf\u5e26\u6709\u6307\u5b9a\u6ce8\u89e3\u7684\u7c7b\u4e0b\u6240\u6709\u63a5\u53e3\n                        \/\/.withMethodAnnotation(PostMapping.class) \/\/ \u626b\u63cf\u5e26\u6709\u53ea\u5f53\u6ce8\u89e3\u7684\u65b9\u6cd5\u63a5\u53e3\n                )\n                .paths(PathSelectors\n                        .any() \/\/ \u6ee1\u8db3\u6761\u4ef6\u7684\u8def\u5f84\uff0c\u8be5\u65ad\u8a00\u603b\u4e3atrue\n                        \/\/.none() \/\/ \u4e0d\u6ee1\u8db3\u6761\u4ef6\u7684\u8def\u5f84\uff0c\u8be5\u65ad\u8a00\u603b\u4e3afalse\uff08\u53ef\u7528\u4e8e\u751f\u6210\u73af\u5883\u5c4f\u853d swagger\uff09\n                        \/\/.ant(&quot;\/user\/**&quot;) \/\/ \u6ee1\u8db3\u5b57\u7b26\u4e32\u8868\u8fbe\u5f0f\u8def\u5f84\n                        \/\/.regex(&quot;&quot;) \/\/ \u7b26\u5408\u6b63\u5219\u7684\u8def\u5f84\n                )\n                .build()\n                \/\/ \u662f\u5426\u5f00\u542fswagger\n                .enable(flag)\n                \/\/ \u6dfb\u52a0\u8bf7\u6c42\u5934\u53c2\u6570\n                .globalOperationParameters(parameters);\n\n    }\n\n    \/\/ \u914d\u7f6e\u57fa\u672c\u4fe1\u606f\n    private ApiInfo apiInfo() {\n        Contact contact = new Contact(\n                &quot;TRR&quot;, \/\/ \u4f5c\u8005\u59d3\u540d\n                &quot;https:\/\/rrt01.cn&quot;, \/\/ \u4f5c\u8005\u7f51\u7ad9\n                &quot;11111115@qq.com&quot;); \/\/ \u90ae\u7bb1\n        return new ApiInfoBuilder()\n                .title(&quot;aaa-\u63a5\u53e3\u6587\u6863&quot;) \/\/ \u6807\u9898\n                .description(&quot;\u9ed1\u6697\u4e2d\u7684\u4e00\u70b9\u5149&quot;) \/\/ \u63cf\u8ff0\n                .termsOfServiceUrl(&quot;https:\/\/www.baidu.com&quot;) \/\/\u8df3\u8f6c\u94fe\u63a5\n                .version(&quot;1.0&quot;) \/\/ \u7248\u672c\n                .license(&quot;Swagger\u6559\u7a0b&quot;)\n                .licenseUrl(&quot;https:\/\/rrt01.cn&quot;)\n                .contact(contact)\n                .build();\n    }\n}<\/code><\/pre>\n","protected":false},"excerpt":{"rendered":"<p>\u4e00\u3001\u7b80\u4ecb \u5b98\u7f51\uff1ahttps:\/\/swagger.io\/ Swagger\u7528\u4e8e\u751f\u6210\u3001\u63cf\u8ff0\u3001\u8c03\u7528\u548c\u53ef\u89c6\u5316Restfu&#8230;<\/p>\n","protected":false},"author":1,"featured_media":18,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[3],"tags":[],"class_list":["post-101","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-3"],"views":1348,"_links":{"self":[{"href":"https:\/\/rrt01.cn\/index.php?rest_route=\/wp\/v2\/posts\/101"}],"collection":[{"href":"https:\/\/rrt01.cn\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/rrt01.cn\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/rrt01.cn\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/rrt01.cn\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=101"}],"version-history":[{"count":2,"href":"https:\/\/rrt01.cn\/index.php?rest_route=\/wp\/v2\/posts\/101\/revisions"}],"predecessor-version":[{"id":103,"href":"https:\/\/rrt01.cn\/index.php?rest_route=\/wp\/v2\/posts\/101\/revisions\/103"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/rrt01.cn\/index.php?rest_route=\/wp\/v2\/media\/18"}],"wp:attachment":[{"href":"https:\/\/rrt01.cn\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=101"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/rrt01.cn\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=101"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/rrt01.cn\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=101"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}