{"id":10008200,"date":"2023-08-31T13:00:01","date_gmt":"2023-08-31T05:00:01","guid":{"rendered":"https:\/\/blog.itmax.cn\/?p=10008200"},"modified":"2023-08-31T13:00:01","modified_gmt":"2023-08-31T05:00:01","slug":"%e8%b0%81%e5%ae%b6%e9%9d%a2%e8%af%95%e5%be%80%e6%ad%bb%e9%87%8c%e9%97%ae-swagger-%e5%95%8a%ef%bc%9f","status":"publish","type":"post","link":"https:\/\/itmax.cn\/?p=10008200","title":{"rendered":"\u8c01\u5bb6\u9762\u8bd5\u5f80\u6b7b\u91cc\u95ee Swagger \u554a\uff1f"},"content":{"rendered":"

\u5927\u5bb6\u597d\uff0c\u6211\u662f\u5c0f\u5bcc\uff5e<\/strong><\/p>\n

\u524d\u8a00<\/h2>\n

\u8bf4\u4e2a\u633a\u5947\u8469\u7684\u4e8b\uff0c\u6709\u4e2a\u8001\u94c1\u7ed9\u6211\u53d1\u79c1\u4fe1\u5410\u69fd\u4e86\u4e00\u4e0b\u5b83\u7684\u9762\u8bd5\u7ecf\u5386\uff0c\u4ed6\u53bb\u4e86\u4e2a\u56fd\u4f01\u5355\u4f4d\u9762\u8bd5\uff0c\u7136\u540e\u9762\u8bd5\u5b98\u8ddf\u4ed6\u5c31Swagger\u7684\u95ee\u9898\u804a\u4e86\u534a\u4e2a\u591a\u5c0f\u65f6\u3002\u989d\uff5e \u9762\u8bd5\u561b\u8fd9\u4e9b\u90fd\u4e0d\u7a00\u5947\uff0c\u603b\u80fd\u9047\u5230\u662f\u5343\u5947\u767e\u602a\u7684\u4eba\uff0c\u5343\u5947\u767e\u602a\u7684\u95ee\u9898\u3002\u4e0d\u8fc7\uff0c\u6211\u5206\u6790\u8fd9\u4e2a\u9762\u8bd5\u5b98\u662f\u4e0d\u592a\u597d\u610f\u601d\u76f4\u63a5\u8ba9\u4ed6\u8d70\uff0c\u54c8\u54c8\u54c8\uff01<\/p>\n

\"\u5728\u8fd9\u91cc\u63d2\u5165\u56fe\u7247\u63cf\u8ff0\"<\/p>\n

\u4ec0\u4e48\u662fSwagger\uff1f<\/h2>\n

Swagger\u76ee\u524d\u662f\u6bd4\u8f83\u4e3b\u6d41\u7684RESTful<\/code>\u98ce\u683c\u7684API\u6587\u6863\u5de5\u5177\uff0c\u505a\u8fc7\u5f00\u53d1\u7684\u4eba\u5e94\u8be5\u90fd\u7528\u8fc7\u5b83\u5427\uff01<\/p>\n

\"\u5728\u8fd9\u91cc\u63d2\u5165\u56fe\u7247\u63cf\u8ff0\"<\/p>\n

\u5b83\u63d0\u4f9b\u4e86\u4e00\u5957\u5de5\u5177\u548c\u89c4\u8303\uff0c\u8ba9\u5f00\u53d1\u4eba\u5458\u80fd\u591f\u66f4\u8f7b\u677e\u5730\u521b\u5efa\u548c\u7ef4\u62a4\u53ef\u8bfb\u6027\u5f3a\u3001\u6613\u4e8e\u4f7f\u7528\u548c\u4ea4\u4e92\u7684API\u6587\u6863\uff08\u5b98\u65b9\u53e3\u543b\uff09\u3002<\/p>\n

title: Swagger\ndesc: Swagger \u5b98\u65b9\u7f51\u7ad9\nlogo: https:\/\/static1.smartbear.co\/swagger\/media\/assets\/images\/swagger_logo.svg\nlink: https:\/\/swagger.io\/<\/code><\/pre>\n
\u4e3a\u4ec0\u4e48\u7528Swagger\uff1f<\/h2>\n
\u4ee5\u5f80\u5728\u6ca1\u6709\u8fd9\u6837\u7684API\u6587\u6863\u5de5\u5177\uff0c\u5f00\u53d1\u4eba\u5458\u9700\u8981\u624b\u52a8\u7f16\u5199\u548c\u7ef4\u62a4\u529f\u80fdAPI\u7684\u6587\u6863\u3002\u800c\u4e14\uff0c\u7531\u4e8eAPI\u53d8\u66f4\u5f80\u5f80\u96be\u4ee5\u53ca\u65f6\u66f4\u65b0\u5230\u6587\u6863\u4e2d\uff0c\u8fd9\u53ef\u80fd\u4f1a\u7ed9\u4f9d\u8d56\u6587\u6863\u7684\u5f00\u53d1\u8005\u5e26\u6765\u56f0\u60d1\u3002<\/p>\n
\u8bf4\u51e0\u4e2aSwagger<\/code>\u7684\u7279\u70b9\uff1a<\/p>\n
    \n
  • \u6700\u91cd\u8981\u7684\u4e00\u70b9\u53ef\u4ee5\u6839\u636e\u4ee3\u7801\u6ce8\u89e3\u81ea\u52a8\u751f\u6210API\u6587\u6863\uff0c\u80fd\u751f\u6210\u7684\u7edd\u5bf9\u4e0d\u624b\u5199<\/code>\uff0c\u800c\u4e14API\u6587\u6863\u4e0eAPI\u5b9a\u4e49\u4f1a\u540c\u6b65\u66f4\u65b0\u3002<\/li>\n
  • \u5b83\u63d0\u4f9b\u4e86\u4e00\u4e2a\u53ef\u6267\u884c\u7684Web\u754c\u9762\uff0c\u652f\u6301API\u5728\u7ebf\u6d4b\u8bd5\uff0c\u53ef\u4ee5\u76f4\u63a5\u5728\u754c\u9762\u4e0a\u76f4\u63a5\u8bbe\u7f6e\u53c2\u6570\u6d4b\u8bd5\uff0c\u4e0d\u7528\u989d\u5916\u7684\u6d4b\u8bd5\u5de5\u5177\u6216\u63d2\u4ef6\u3002<\/li>\n
  • \u652f\u6301\u591a\u79cd\u7f16\u7a0b\u8bed\u8a00\uff0cJava<\/code>\u3001PHP<\/code>\u3001Python<\/code>\u7b49\u8bed\u8a00\u90fd\u652f\u6301\uff0c\u559c\u6b22\u4ec0\u4e48\u8bed\u8a00\u6784\u5efaAPI\u90fd\u884c\u3002<\/li>\n<\/ul>\n
    \u603b\u7684\u6765\u8bf4\uff0cSwagger\u53ef\u4ee5\u8ba9\u6211\u4eec\u66f4\u591a\u65f6\u95f4\u5728\u4e13\u6ce8\u4e8e\u7f16\u5199\u4ee3\u7801\uff08\u6478\u9c7c\uff09\uff0c\u800c\u4e0d\u662f\u82b1\u8d39\u989d\u5916\u7cbe\u529b\u6765\u7ef4\u62a4\u6587\u6863\uff0c\u5b9e\u8df5\u51fa\u771f\u77e5\u5148\u8dd1\u4e2ademo\u8bd5\u8bd5\u3002<\/p>\n
    Swagger\u642d\u5efa<\/h2>\n
    maven \u4f9d\u8d56<\/h3>\n
    \u76ee\u524d\u4f7f\u7528\u7684\u7248\u672c\u662fSwagger3.0\u3001Springboot 2.7.6\uff0cSwagger2.0\u4e0e3.0\u4f9d\u8d56\u5305\u540d\u79f0\u7684\u53d8\u5316\u6709\u4e9b\u5927\uff0c\u9700\u8981\u7279\u522b\u6ce8\u610f\u4e00\u4e0b\u3002<\/p>\n
    <dependency>\n    <groupId>org.springframework.boot<\/groupId>\n    <artifactId>spring-boot-starter-web<\/artifactId>\n    <version>2.7.6<\/version>\n<\/dependency>\n\n<dependency>\n    <groupId>io.springfox<\/groupId>\n    <artifactId>springfox-boot-starter<\/artifactId>\n    <version>3.0.0<\/version>\n<\/dependency>\n<\/code><\/pre>\n
    \u914d\u7f6e\u7c7b<\/h3>\n
    \u9996\u5148\u6211\u4eec\u521b\u5efa\u4e00\u4e2a\u63a7\u5236\u5668TestController<\/code>\u7c7b\uff0c\u91cc\u8fb9\u53ea\u6709\u4e00\u4e2a\u6700\u7b80\u5355\u7684\u8bf7\u6c42 \/test<\/code>\u3002<\/p>\n
    @RestController\npublic class TestController {\n\n    @RequestMapping("\/test")\n    public String test(String name) {\n        return name;\n    }\n}<\/code><\/pre>\n
    \u63a5\u4e0b\u6765\u521b\u5efa\u914d\u7f6e\u7c7bSwaggerConfig<\/code>\uff0c\u7c7b\u6807\u6ce8@EnableSwagger2<\/code>\u6ce8\u89e3\u662f\u5173\u952e\uff0c\u5230\u8fd9\u6700\u7b80\u5355\u7684Swagger\u6587\u6863\u73af\u5883\u5c31\u642d\u5efa\u597d\u4e86\u3002<\/p>\n
    import org.springframework.context.annotation.Configuration;\nimport springfox.documentation.swagger2.annotations.EnableSwagger2;\n\n@Configuration\n@EnableSwagger2\npublic class SwaggerConfig {\n\n}<\/code><\/pre>\n
    \u542f\u52a8\u62a5\u9519<\/h3>\n
    \u542f\u52a8\u65f6\u53ef\u80fd\u4f1a\u62a5\u5982\u4e0b\u7684\u9519\u8bef\uff0c\u8fd9\u662f\u7531\u4e8e\u9ad8\u7248\u672c\u7684Springboot<\/code>\u4e0eSwagger<\/code>\u7248\u672c\u4f7f\u7528\u7684\u8def\u5f84\u5339\u914d\u7b56\u7565\u51b2\u7a81\u5bfc\u81f4\u7684\u3002<\/p>\n
    Springfox<\/code>\u4f7f\u7528\u7684\u8def\u5f84\u5339\u914d\u89c4\u5219\u4e3aAntPathMatcher<\/code> \u7684\uff0c\u800cSpringBoot2.7.6<\/code>\u4f7f\u7528\u7684\u662fPathPatternMatcher<\/code>\uff0c\u4e24\u8005\u51b2\u7a81\u4e86\u3002<\/p><\/blockquote>\n
    org.springframework.context.ApplicationContextException: Failed to start bean 'documentationPluginsBootstrapper'; nested exception is java.lang.NullPointerException\n    at org.springframework.context.support.DefaultLifecycleProcessor.doStart(DefaultLifecycleProcessor.java:181) ~[spring-context-5.3.24.jar:5.3.24]\n    at org.springframework.context.support.DefaultLifecycleProcessor.access$200(DefaultLifecycleProcessor.java:54) ~[spring-context-5.3.24.jar:5.3.24]\n    at org.springframework.context.support.DefaultLifecycleProcessor$LifecycleGroup.start(DefaultLifecycleProcessor.java:356) ~[spring-context-5.3.24.jar:5.3.24]\n    at java.lang.Iterable.forEach(Iterable.java:75) ~[na:1.8.0_341]\n    at org.springframework.context.support.DefaultLifecycleProcessor.startBeans(DefaultLifecycleProcessor.java:155) ~[spring-context-5.3.24.jar:5.3.24]\n    at org.springframework.context.support.DefaultLifecycleProcessor.onRefresh(DefaultLifecycleProcessor.java:123) ~[spring-context-5.3.24.jar:5.3.24]\n    at org.springframework.context.support.AbstractApplicationContext.finishRefresh(AbstractApplicationContext.java:935) ~[spring-context-5.3.24.jar:5.3.24]\n    at org.springframework.context.support.AbstractApplicationContext.refresh(AbstractApplicationContext.java:586) ~[spring-context-5.3.24.jar:5.3.24]\n    at org.springframework.boot.web.servlet.context.ServletWebServerApplicationContext.refresh(ServletWebServerApplicationContext.java:147) ~[spring-boot-2.7.6.jar:2.7.6]\n    at org.springframework.boot.SpringApplication.refresh(SpringApplication.java:731) [spring-boot-2.7.6.jar:2.7.6]\n    at org.springframework.boot.SpringApplication.refreshContext(SpringApplication.java:408) [spring-boot-2.7.6.jar:2.7.6]\n    at org.springframework.boot.SpringApplication.run(SpringApplication.java:307) [spring-boot-2.7.6.jar:2.7.6]\n    at org.springframework.boot.SpringApplication.run(SpringApplication.java:1303) [spring-boot-2.7.6.jar:2.7.6]\n    at org.springframework.boot.SpringApplication.run(SpringApplication.java:1292) [spring-boot-2.7.6.jar:2.7.6]\n    at com.springboot101.SwaggerApplication.main(SwaggerApplication.java:10) [classes\/:na]<\/code><\/pre>\n
    \u89e3\u51b3\u65b9\u6848<\/h3>\n
    \u8fd9\u4e2a\u9519\u8bef\u7684\u89e3\u51b3\u529e\u6cd5\u6bd4\u8f83\u591a\uff0c\u6211\u6574\u7406\u4e86\u56db\u79cd\u89e3\u51b3\u6b64\u95ee\u9898\u7684\u65b9\u6848\uff0c\u4f60\u770b\u54ea\u4e2a\u66f4\u5408\u9002\u4f60\u3002<\/p>\n
    1\u3001\u964d\u4f4e\u7248\u672c<\/h4>\n
    SpringBoot\u7248\u672c\u964d\u4f4e\u52302.5.X \u3001springfox\u964d\u52303.X \u4ee5\u4e0b\u53ef\u4ee5\u89e3\u51b3\u95ee\u9898\uff0c\u4e0d\u8fc7\u4e0d\u63a8\u8350\u8fd9\u4e48\u505a\uff0c\u6bd5\u7adf\u964d\u914d\u7f6e\u505a\u517c\u5bb9\u663e\u5f97\u6709\u70b9\u50bb\u3002<\/p>\n
    2\u3001\u7edf\u4e00\u8def\u5f84\u5339\u914d\u7b56\u7565<\/h4>\n
    \u5c06SpringMVC<\/code>\u7684\u5339\u914dURL\u8def\u5f84\u7684\u7b56\u7565\u6539\u4e3aant_path_matcher<\/code>\uff0capplication.yml<\/code>\u6587\u4ef6\u589e\u52a0\u5982\u4e0b\u7684\u914d\u7f6e\uff1a<\/p>\n
    spring:\n  mvc:\n    pathmatch:\n      matching-strategy: ant_path_matcher<\/code><\/pre>\n
    3\u3001@EnableWebMvc\u6ce8\u89e3<\/h4>\n
    \u5728\u914d\u7f6e\u7c7bSwaggerConfig<\/code>\u4e0a\u6807\u6ce8@EnableWebMvc<\/code>\u6ce8\u89e3\u4e5f\u53ef\u4ee5\u89e3\u51b3\u3002<\/p>\n
    Swagger<\/code>\u6846\u67b6\u9700\u8981\u901a\u8fc7\u89e3\u6790\u548c\u626b\u63cf\u5e26\u6709\u6ce8\u89e3\u7684Controller<\/code>\u7c7b\u548c\u65b9\u6cd5\u6765\u751f\u6210API\u6587\u6863\u3002@EnableWebMvc<\/code>\u6ce8\u89e3\u4f1a\u6ce8\u518c\u4e00\u4e2aRequestMappingHandlerMapping<\/code>\u7684Bean\uff0c\u5e76\u5c06\u5176\u4f5c\u4e3a\u9ed8\u8ba4\u7684\u8bf7\u6c42\u6620\u5c04\u5904\u7406\u5668\uff0c\u4ee5\u786e\u4fdd\u8fd9\u4e9bController\u7c7b\u548c\u65b9\u6cd5\u80fd\u591f\u88ab\u6b63\u786e\u5904\u7406\uff0c\u53ef\u4ee5\u4e0eSwagger\u7684\u8def\u5f84\u914d\u7f6e\u89c4\u5219\u76f8\u5339\u914d\uff0c\u4ece\u800c\u4f7f\u5f97Swagger\u80fd\u591f\u6210\u529f\u751f\u6210API\u6587\u6863\u3002<\/p>\n
    @EnableWebMvc\n@Configuration\n@EnableSwagger2\npublic class SwaggerConfig {\n\n}<\/code><\/pre>\n
    4\u3001\u6ce8\u518c BeanPostProcessor<\/h4>\n
    \u4e5f\u53ef\u4ee5\u81ea\u884c\u5b9e\u73b0\u517c\u5bb9\u903b\u8f91\u6765\u89e3\u51b3\u8fd9\u4e2a\u95ee\u9898\uff0c\u6211\u4eec\u53ef\u4ee5\u5728Spring<\/code>\u5bb9\u5668\u4e2d\u6ce8\u518c\u4e00\u4e2aBeanPostProcessor<\/code>\uff0c\u5728\u8be5\u5904\u7406\u5668\u4e2d\u5bf9 HandlerMappings \u8fdb\u884c\u5b9a\u5236\u3002<\/p>\n
    \u901a\u8fc7\u8fc7\u6ee4\u6389\u5df2\u5b58\u5728PatternParser\u7684\u6620\u5c04\uff0c\u610f\u5473\u7740\u6211\u4eec\u53ef\u4ee5\u5c06Swagger\u7279\u5b9a\u7684HandlerMappings\u6dfb\u52a0\u5230HandlerMappings<\/code>\u5217\u8868\u4e2d\uff0c\u4ece\u800c\u4f7f\u7528\u81ea\u5b9a\u4e49\u7684\u8bbe\u7f6e\u6765\u66ff\u4ee3\u539f\u6709\u7684HandlerMappings\u3002<\/p>\n
    \u8fd9\u6837\u4fee\u590d\u4e86\u53ef\u80fd\u5bfc\u81f4Swagger\u65e0\u6cd5\u6b63\u5e38\u4f7f\u7528\u7684\u95ee\u9898\u3002<\/p>\n
    @Bean\npublic static BeanPostProcessor springfoxHandlerProviderBeanPostProcessor() {\n    return new BeanPostProcessor() {\n\n        @Override\n        public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {\n            if (bean instanceof WebMvcRequestHandlerProvider || bean instanceof WebFluxRequestHandlerProvider) {\n                customizeSpringfoxHandlerMappings(getHandlerMappings(bean));\n            }\n            return bean;\n        }\n\n        private <T extends RequestMappingInfoHandlerMapping> void customizeSpringfoxHandlerMappings(List<T> mappings) {\n            List<T> copy = mappings.stream()\n                    .filter(mapping -> mapping.getPatternParser() == null)\n                    .collect(Collectors.toList());\n            mappings.clear();\n            mappings.addAll(copy);\n        }\n\n        @SuppressWarnings("unchecked")\n        private List<RequestMappingInfoHandlerMapping> getHandlerMappings(Object bean) {\n            try {\n                Field field = ReflectionUtils.findField(bean.getClass(), "handlerMappings");\n                field.setAccessible(true);\n                return (List<RequestMappingInfoHandlerMapping>) field.get(bean);\n            } catch (IllegalArgumentException | IllegalAccessException e) {\n                log.warn("\u4fee\u6539WebMvcRequestHandlerProvider\u7684\u5c5e\u6027\uff1ahandlerMappings\u51fa\u9519\uff0c\u53ef\u80fd\u5bfc\u81f4swagger\u4e0d\u53ef\u7528", e);\n                throw new IllegalStateException(e);\n            }\n        }\n    };\n}<\/code><\/pre>\n
    \u8bbf\u95ee swagger-ui<\/h3>\n
    \u5230\u8fd9\uff0c\u95ee\u9898\u89e3\u51b3\uff01\u6211\u4eec\u8bbf\u95eeSwagger\u6587\u6863\u8def\u5f84 http:\/\/127.0.0.1:9002\/swagger-ui\/index.html<\/code> \uff0c\u80fd\u591f\u770b\u5230\u6211\u4eec\u5199\u7684 API \u4fe1\u606f\u4ee5\u53ca\u4e00\u4e9bSwagger \u6587\u6863\u7684\u9ed8\u8ba4\u914d\u7f6e\u4fe1\u606f\u3002<\/p>\n
    \"\u5728\u8fd9\u91cc\u63d2\u5165\u56fe\u7247\u63cf\u8ff0\"
    \u6ce8\u610f\u5230\u6211\u4eec\u53ea\u5199\u4e86\u4e00\u4e2a \/test<\/code>\u63a5\u53e3\uff0c\u4f46\u8fd9\u91cc\u786e\u628a\u8fd9\u4e2a\u65b9\u6cd5\u7684\u6240\u6709\u8bf7\u6c42\u65b9\u5f0f\u90fd\u5217\u4e86\u51fa\u6765\uff0c\u56e0\u4e3a\u6211\u4eec\u5728 controller<\/code> \u65b9\u6cd5\u4e2d\u4f7f\u7528\u4e86@RequestMapping<\/code>\u6ce8\u89e3\uff0c\u5e76\u6ca1\u6709\u5177\u4f53\u7684\u6307\u5b9a\u63a5\u53e3\u7684\u8bf7\u6c42\u65b9\u5f0f\uff0c\u6240\u4ee5\u907f\u514d\u6587\u6863\u5197\u4f59\uff0c\u5c3d\u91cf\u6307\u5b9a\u8bf7\u6c42\u65b9\u5f0f\u6216\u8005\u4f7f\u7528\u6307\u5b9a\u8bf7\u6c42\u65b9\u5f0f\u7684 @XXXMapping<\/code> \u6ce8\u89e3\u3002<\/p>\n
    \u6307\u5b9a\u8bf7\u6c42\u65b9\u5f0f\u540e\uff1a
    \"\u5728\u8fd9\u91cc\u63d2\u5165\u56fe\u7247\u63cf\u8ff0\"<\/p>\n
    API\u6587\u6863\u914d\u7f6e<\/h2>\n
    \u4e0a\u8fb9\u6211\u4eec\u8bbf\u95ee\u7684\u6587\u6863\u4e2d\u5c55\u793a\u7684\u6570\u636e\u90fd\u662f\u9ed8\u8ba4\u7684\u914d\u7f6e\uff0c\u73b0\u5728\u54b1\u4eec\u6765\u5b9a\u5236\u5316\u4e00\u4e0b\u6587\u6863\u3002<\/p>\n
    Springfox<\/code>\u63d0\u4f9b\u4e86\u4e00\u4e2aDocket<\/code>\u5bf9\u8c61\uff0c\u4f9b\u6211\u4eec\u7075\u6d3b\u7684\u914d\u7f6eSwagger<\/code>\u7684\u5404\u9879\u5c5e\u6027\u3002Docket<\/code>\u5bf9\u8c61\u5185\u63d0\u4f9b\u4e86\u5f88\u591a\u7684\u65b9\u6cd5\u6765\u914d\u7f6e\u6587\u6863\uff0c\u4e0b\u8fb9\u4ecb\u7ecd\u4e0b\u5e38\u7528\u7684\u914d\u7f6e\u9879\u3002<\/p>\n
    select<\/h3>\n
    select()<\/code>\u8fd4\u56de\u4e00\u4e2aApiSelectorBuilder<\/code>\u5bf9\u8c61\uff0c\u662f\u4f7f\u7528apis()<\/code>\u3001paths()<\/code>\u4e24\u4e2a\u65b9\u6cd5\u7684\u524d\u63d0\uff0c\u7528\u4e8e\u6307\u5b9aSwagger\u8981\u626b\u63cf\u7684\u63a5\u53e3\u548c\u8def\u5f84\u3002<\/p>\n
    apis<\/h3>\n
    \u9ed8\u8ba4\u60c5\u51b5\u4e0b\uff0cSwagger\u4f1a\u626b\u63cf\u6574\u4e2a\u9879\u76ee\u4e2d\u7684\u63a5\u53e3\uff0c\u901a\u8fc7 apis()<\/code>\u65b9\u6cd5\uff0c\u4f60\u53ef\u4ee5\u4f20\u5165\u4e00\u4e2aRequestHandlerSelector<\/code>\u5bf9\u8c61\u5b9e\u4f8b\u6765\u6307\u5b9a\u8981\u5305\u542b\u7684\u63a5\u53e3\u6240\u5728\u7684\u5305\u8def\u5f84\u3002<\/p>\n
    @Bean\npublic Docket docket(Environment environment) {\n    return new Docket(DocumentationType.SWAGGER_2)\n            .select()\n            .apis(RequestHandlerSelectors.basePackage("com.springboot101.controller"))\n            .build();\n}<\/code><\/pre>\n
    paths<\/h3>\n
    \u4ec5\u5c06\u67d0\u4e9b\u7279\u5b9a\u8bf7\u6c42\u8def\u5f84\u7684API<\/code>\u5c55\u793a\u5728Swagger\u6587\u6863\u4e2d\uff0c\u4f8b\u5982\u8def\u5f84\u4e2d\u5305\u542b\/test<\/code>\u3002\u53ef\u4ee5\u4f7f\u7528 apis()<\/code> \u548c paths()<\/code>\u65b9\u6cd5\u4e00\u8d77\u6765\u8fc7\u6ee4\u63a5\u53e3\u3002<\/p>\n
    @Bean\npublic Docket docket(Environment environment) {\n    return new Docket(DocumentationType.SWAGGER_2)\n            .select()\n            .paths(PathSelectors.ant("\/test\/**"))\n            .build();\n}<\/code><\/pre>\n
    groupName<\/h3>\n
    \u4e3a\u751f\u6210\u7684Swagger<\/code>\u6587\u6863\u6307\u5b9a\u5206\u7ec4\u7684\u540d\u79f0\uff0c\u7528\u6765\u533a\u5206\u4e0d\u540c\u7684\u6587\u6863\u7ec4\u3002<\/p>\n
    @Bean\npublic Docket docket(Environment environment) {\n    return new Docket(DocumentationType.SWAGGER_2)\n            .groupName("\u7528\u6237\u5206\u7ec4")\n            .build();\n}<\/code><\/pre>\n
    \"\u5728\u8fd9\u91cc\u63d2\u5165\u56fe\u7247\u63cf\u8ff0\"<\/p>\n
    \u5b9e\u73b0\u6587\u6863\u7684\u591a\u4e2a\u5206\u7ec4\uff0c\u5219\u9700\u521b\u5efa\u591a\u4e2a Docket<\/code> \u5b9e\u4f8b\uff0c\u8bbe\u7f6e\u4e0d\u540c\u7684\u7ec4\u540d\uff0c\u548c\u7ec4\u5185\u8fc7\u6ee4 API \u7684\u6761\u4ef6\u3002<\/p>\n
    @Bean\npublic Docket docket1(Environment environment) {\n    return new Docket(DocumentationType.SWAGGER_2)\n            .groupName("\u5546\u5bb6\u5206\u7ec4")\n            .select()\n            .paths(PathSelectors.ant("\/test1\/**"))\n            .build();\n}<\/code><\/pre>\n
    \"\u5728\u8fd9\u91cc\u63d2\u5165\u56fe\u7247\u63cf\u8ff0\"<\/p>\n
    apiInfo<\/h3>\n
    \u8bbe\u7f6eAPI\u6587\u6863\u7684\u57fa\u672c\u4fe1\u606f\uff0c\u4f8b\u5982\u6807\u9898\u3001\u63cf\u8ff0\u3001\u7248\u672c\u7b49\u3002\u4f60\u53ef\u4ee5\u4f7f\u7528ApiInfo<\/code>\u5bf9\u8c61\u81ea\u5b9a\u4e49\u4fe1\u606f\u3002<\/p>\n
    @Bean\npublic Docket docket(Environment environment) {\n    return new Docket(DocumentationType.SWAGGER_2)\n            .apiInfo(apiInfo()); \/\/ \u6587\u6863\u57fa\u7840\u914d\u7f6e\n}\n\nprivate ApiInfo apiInfo() {\n    Contact contact = new Contact("\u5c0f\u5bcc", "http:\/\/fire100.top", "email@example.com");\n    return new ApiInfoBuilder()\n            .title("Swagger\u5b66\u4e60")\n            .description("\u7a0b\u5e8f\u5458\u5c0f\u5bcc-\u5e26\u4f60\u4e00\u8d77\u5b66\u4e60 Swagger")\n            .version("v1.0.1")\n            .termsOfServiceUrl("http:\/\/fire100.top")\n            .contact(contact)\n            .license("\u8bb8\u53ef\u8bc1")\n            .licenseUrl("\u8bb8\u53ef\u94fe\u63a5")\n            .extensions(Arrays.asList(\n                    new StringVendorExtension("\u6211\u662f", "\u5c0f\u5bcc"),\n                    new StringVendorExtension("\u4f60\u662f", "\u8c01")\n            ))\n            .build();\n}<\/code><\/pre>\n
    \u5bf9\u5e94\u7684Swagger\u6587\u6863\u9875\u9762\u4e0a\u5c55\u793a\u7684\u4f4d\u7f6e<\/p>\n
    \"\u5728\u8fd9\u91cc\u63d2\u5165\u56fe\u7247\u63cf\u8ff0\"<\/p>\n
    enable<\/h3>\n
    \u542f\u7528\u6216\u7981\u7528Swagger\u6587\u6863\u7684\u751f\u6210\uff0c\u6709\u65f6\u6d4b\u8bd5\u73af\u5883\u4f1a\u5f00\u653eAPI\u6587\u6863\uff0c\u4f46\u5728\u751f\u4ea7\u73af\u5883\u5219\u8981\u7981\u7528\uff0c\u53ef\u4ee5\u6839\u636e\u73af\u5883\u53d8\u91cf\u63a7\u5236\u662f\u5426\u663e\u793a\u3002<\/p>\n
    @Bean\npublic Docket docket(Environment environment) {\n    \/\/ \u53ef\u663e\u793a swagger \u6587\u6863\u7684\u73af\u5883\n    Profiles of = Profiles.of("dev", "test","pre");\n    boolean enable = environment.acceptsProfiles(of);\n\n    return new Docket(DocumentationType.SWAGGER_2)\n            .enable(enable)\n            .apiInfo(apiInfo()); \/\/ \u6587\u6863\u57fa\u7840\u914d\u7f6e\n}<\/code><\/pre>\n
    host<\/h3>\n
    API\u6587\u6863\u663e\u793a\u7684\u4e3b\u673a\u540d\u79f0\u6216IP\u5730\u5740\uff0c\u5373\u5728\u6d4b\u8bd5\u6267\u884c\u63a5\u53e3\u65f6\u4f7f\u7528\u7684IP\u6216\u57df\u540d\u3002<\/p>\n
    @Bean\npublic Docket docket(Environment environment) {\n    return new Docket(DocumentationType.SWAGGER_2)\n            .host("http:\/\/test.com") \/\/ \u8bf7\u6c42\u5730\u5740\n            .apiInfo(apiInfo()); \/\/ \u6587\u6863\u57fa\u7840\u914d\u7f6e\n}<\/code><\/pre>\n
    securitySchemes<\/h3>\n
    \u914d\u7f6eAPI\u5b89\u5168\u8ba4\u8bc1\u65b9\u5f0f\uff0c\u6bd4\u5982\u5e38\u89c1\u7684\u5728header<\/code>\u4e2d\u8bbe\u7f6e\u5982Bearer<\/code>\u3001Authorization<\/code>\u3001Basic<\/code>\u7b49\u9274\u6743\u5b57\u6bb5\uff0cApiKey<\/code>\u5bf9\u8c61\u4e2d\u5b57\u6bb5\u542b\u4e49\u5206\u522b\u662f\u522b\u540d\u3001\u9274\u6743\u5b57\u6bb5key\u3001\u9274\u6743\u5b57\u6bb5\u6dfb\u52a0\u7684\u4f4d\u7f6e\u3002<\/p>\n
    @Bean\npublic Docket docket(Environment environment) {\n    return new Docket(DocumentationType.SWAGGER_2)\n            .securitySchemes(\n                    Arrays.asList(\n                            new ApiKey("Bearer\u9274\u6743", "Bearer", "header"),\n                            new ApiKey("Authorization\u9274\u6743", "Authorization", "header"),\n                            new ApiKey("Basic\u9274\u6743", "Basic", "header")\n                    )\n            );\n}<\/code><\/pre>\n
    \u8fd9\u6837\u914d\u7f6e\u540e\uff0cSwagger\u6587\u6863\u5c06\u4f1a\u5305\u542b\u4e00\u4e2aAuthorize<\/code>\u6309\u94ae\uff0c\u4f9b\u7528\u6237\u8f93\u5165\u6211\u4eec\u8bbe\u5b9a\u7684Bearer<\/code> \u3001Authorization<\/code>\u3001Basic<\/code>\u8fdb\u884c\u8eab\u4efd\u9a8c\u8bc1\u3002<\/p>\n
    \"\u5728\u8fd9\u91cc\u63d2\u5165\u56fe\u7247\u63cf\u8ff0\"<\/p>\n
    securityContexts<\/h3>\n
    securitySchemes<\/code>\u65b9\u6cd5\u4e2d\u867d\u7136\u8bbe\u7f6e\u4e86\u9274\u6743\u5b57\u6bb5\uff0c\u4f46\u6b64\u65f6\u5728\u6d4b\u8bd5\u63a5\u53e3\u7684\u65f6\u5019\u4e0d\u4f1a\u81ea\u52a8\u5728 header<\/code>\u4e2d\u52a0\u4e0a\u9274\u6743\u5b57\u6bb5\u548c\u503c\uff0c\u8fd8\u8981\u914d\u7f6eAPI\u7684\u5b89\u5168\u4e0a\u4e0b\u6587\uff0c\u6307\u5b9a\u54ea\u4e9b\u63a5\u53e3\u9700\u8981\u8fdb\u884c\u5b89\u5168\u8ba4\u8bc1\u3002<\/p>\n
    @Bean\npublic Docket docket(Environment environment) {\n    return new Docket(DocumentationType.SWAGGER_2)\n            .securitySchemes(\n                    Arrays.asList(\n                            new ApiKey("Bearer\u9274\u6743", "Bearer", "header"),\n                            new ApiKey("Authorization\u9274\u6743", "Authorization", "header"),\n                            new ApiKey("Basic\u9274\u6743", "Basic", "header")\n                    )\n            )\n            .securityContexts(Collections.singletonList(securityContext()));\n}\n\nprivate SecurityContext securityContext() {\n    return SecurityContext.builder()\n            .securityReferences(\n                    Arrays.asList(\n                            new SecurityReference("Authorization", new AuthorizationScope[0]),\n                            new SecurityReference("Bearer", new AuthorizationScope[0]),\n                            new SecurityReference("Basic", new AuthorizationScope[0])))\n            .build();\n}<\/code><\/pre>\n
    \u73b0\u5728\u5728\u6d4b\u8bd5\u8c03\u7528API\u63a5\u53e3\u65f6\uff0cheader<\/code>\u4e2d\u53ef\u4ee5\u6b63\u5e38\u52a0\u4e0a\u9274\u6743\u5b57\u6bb5\u548c\u503c\u4e86\u3002<\/p>\n
    \"\u5728\u8fd9\u91cc\u63d2\u5165\u56fe\u7247\u63cf\u8ff0\"<\/p>\n
    tags<\/h3>\n
    \u4e3aAPI\u6587\u6863\u4e2d\u7684\u63a5\u53e3\u6dfb\u52a0\u6807\u7b7e\uff0c\u6807\u7b7e\u53ef\u4ee5\u7528\u6765\u5bf9API\u8fdb\u884c\u5206\u7c7b\u6216\u5206\u7ec4\uff0c\u5e76\u63d0\u4f9b\u66f4\u597d\u7684\u7ec4\u7ec7\u548c\u5bfc\u822a\u529f\u80fd\u3002<\/p>\n
    @Bean\npublic Docket docket(Environment environment) {\n    return new Docket(DocumentationType.SWAGGER_2)\n            .tags(new Tag("\u5c0f\u5bcc\u63a5\u53e3", "\u5c0f\u5bcc\u76f8\u5173\u7684\u6d4b\u8bd5\u63a5\u53e3"))\n}<\/code><\/pre>\n
    \u6388\u6743\u767b\u5f55<\/h2>\n
    \u51fa\u4e8e\u5bf9\u7cfb\u7edf\u5b89\u5168\u6027\u7684\u8003\u8651\uff0c\u901a\u5e38\u6211\u4eec\u8fd8\u4f1a\u4e3aAPI\u6587\u6863\u589e\u52a0\u767b\u5f55\u529f\u80fd\u3002<\/p>\n
    \u5f15\u5165maven\u4f9d\u8d56<\/h3>\n
    swagger\u7684\u5b89\u5168\u767b\u5f55\u662f\u57fa\u4e8esecurity<\/code>\u5b9e\u73b0\u7684\uff0c\u5f15\u5165\u76f8\u5173\u7684maven<\/code>\u4f9d\u8d56\u3002<\/p>\n
    <dependency>\n    <groupId>org.springframework.boot<\/groupId>\n    <artifactId>spring-boot-starter-security<\/artifactId>\n<\/dependency><\/code><\/pre>\n
    \u767b\u5f55\u914d\u7f6e<\/h3>\n
    application.yml<\/code>\u6587\u4ef6\u4e2d\u914d\u7f6e\u767b\u5f55swagger\u7684\u7528\u6237\u540d\u548c\u5bc6\u7801\u3002<\/p>\n
    spring:\n  security:\n    user:\n      name: admin\n      password: 123456<\/code><\/pre>\n
    \u518d\u6b21\u8bbf\u95ee\u6587\u6863\u5c31\u4f1a\u51fa\u73b0\u5982\u4e0b\u7684\u767b\u5f55\u9875<\/p>\n
    \"\"<\/p>\n
    \u6587\u6863\u6ce8\u89e3<\/h2>\n
    \u5f53\u6211\u4eec\u5e0c\u671b\u5728Swagger\u6587\u6863\u4e2d\u63d0\u4f9b\u8be6\u7ec6\u548c\u5b8c\u6574\u7684\u5185\u5bb9\u65f6\uff0c\u8fd8\u53ef\u4ee5\u4f7f\u7528\u5176\u4ed6\u8bb8\u591aSwagger\u5185\u7f6e\u6ce8\u89e3\u6765\u8fdb\u4e00\u6b65\u4e30\u5bcc\u548c\u5b9a\u5236API\u6587\u6863\u3002<\/p>\n
    @ApiIgnore<\/h3>\n
    \u4e0a\u8fb9\u6211\u4eec\u63d0\u5230\u53ef\u4ee5\u6839\u636e\u6307\u5b9a\u8def\u5f84\u6216\u8005\u5305\u8def\u5f84\u6765\u63d0\u4f9bAPI\uff0c\u4e5f\u53ef\u4ee5\u4f7f\u7528\u7c92\u5ea6\u66f4\u7ec6\u7684@ApiIgnore<\/code>\u6ce8\u89e3\uff0c\u6765\u5b9e\u73b0\u67d0\u4e2aAPI\u5728\u6587\u6863\u4e2d\u5ffd\u7565\u3002<\/p>\n
    @ApiIgnore\n@GetMapping("\/user2\/{id}")\npublic User test2(@PathVariable Integer id, @RequestBody User user) {\n    return user;\n}<\/code><\/pre>\n
    @ApiModel<\/h3>\n
    \u5728\u6211\u4eec\u7684\u63a5\u53e3\u4e2d\uff0c\u53ea\u8981\u4f7f\u7528\u5b9e\u4f53\u4f5c\u4e3a\u53c2\u6570\u6216\u54cd\u5e94\u4f53\uff0cSwagger\u5c31\u4f1a\u81ea\u52a8\u626b\u63cf\u5230\u5b83\u4eec\uff0c\u4f46\u4f60\u4f1a\u53d1\u73b0\u76ee\u524d\u8fd9\u4e9b\u5b9e\u4f53\u7f3a\u4e4f\u8be6\u7ec6\u7684\u63cf\u8ff0\u4fe1\u606f\u3002\u4e3a\u4e86\u8ba9\u4f7f\u7528\u8005\u901a\u4fd7\u6613\u61c2\uff0c\u9700\u8981\u4f7f\u7528swagger\u63d0\u4f9b\u7684\u6ce8\u89e3\u4e3a\u8fd9\u4e9b\u5b9e\u4f53\u6dfb\u52a0\u8be6\u7ec6\u7684\u63cf\u8ff0\u3002
    \"\u5728\u8fd9\u91cc\u63d2\u5165\u56fe\u7247\u63cf\u8ff0\"<\/p>\n
    @ApiModel<\/code>\u6ce8\u89e3\u7684\u4f7f\u7528\u5728\u5b9e\u4f53\u7c7b\u4e0a\uff0c\u63d0\u4f9b\u5bf9Swagger Model\u989d\u5916\u4fe1\u606f\u7684\u63cf\u8ff0\u3002<\/p>\n
    \"\"<\/p>\n
    @ApiModelProperty<\/h3>\n
    @ApiModelProperty<\/code> \u6ce8\u89e3\u4e3a\u5b9e\u4f53\u7c7b\u4e2d\u7684\u5c5e\u6027\u6dfb\u52a0\u63cf\u8ff0\uff0c\u63d0\u4f9b\u4e86\u5b57\u6bb5\u540d\u79f0\u3001\u662f\u5426\u5fc5\u586b\u3001\u5b57\u6bb5\u793a\u4f8b\u7b49\u63cf\u8ff0\u4fe1\u606f\u3002<\/p>\n
    @ApiModel(value = "\u7528\u6237\u5b9e\u4f53\u7c7b", description = "\u7528\u4e8e\u5b58\u653e\u7528\u6237\u767b\u5f55\u4fe1\u606f")\n@Data\npublic class User {\n\n    @ApiModelProperty(value = "\u7528\u6237\u540d\u5b57\u6bb5", required = true, example = "#\u516c\u4f17\u53f7\uff1a\u7a0b\u5e8f\u5458\u5c0f\u5bcc")\n    private String name;\n\n    @ApiModelProperty(value = "\u5e74\u9f84", required = true, example = "19")\n    private Integer age;\n\n    @ApiModelProperty(value = "\u90ae\u7bb1", required = true, example = "#\u516c\u4f17\u53f7\uff1a\u7a0b\u5e8f\u5458\u5c0f\u5bcc")\n    private String email;\n}<\/code><\/pre>\n
    @Api<\/h3>\n
    @Api<\/code> \u6ce8\u89e3\u7528\u4e8e\u6807\u8bb0\u4e00\u4e2a\u63a7\u5236\u5668\uff08controller<\/code>\uff09\u7c7b\uff0c\u5e76\u63d0\u4f9b\u63a5\u53e3\u7684\u8be6\u7ec6\u4fe1\u606f\u548c\u914d\u7f6e\u9879\u3002<\/p>\n