{"id":96,"date":"2022-11-03T15:03:31","date_gmt":"2022-11-03T07:03:31","guid":{"rendered":"https:\/\/xinchewhd.com.cn\/?p=96"},"modified":"2024-01-10T14:37:54","modified_gmt":"2024-01-10T06:37:54","slug":"spring-boot%e5%bc%95%e5%85%a5knife4j%e5%b9%b6%e9%85%8d%e7%bd%ae","status":"publish","type":"post","link":"https:\/\/xinchewhd.com.cn\/index.php\/spring-boot\/spring-boot%e5%bc%95%e5%85%a5knife4j%e5%b9%b6%e9%85%8d%e7%bd%ae\/","title":{"rendered":"Spring boot\u5f15\u5165knife4j\u5e76\u914d\u7f6e"},"content":{"rendered":"\n<p>\u4e00\u3001\u5f15\u5165knife4j\u5bf9\u5e94jar\u5305<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>        &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;exclusions&gt;\n                &lt;exclusion&gt;\n                    &lt;groupId&gt;io.swagger&lt;\/groupId&gt;\n                    &lt;artifactId&gt;swagger-annotations&lt;\/artifactId&gt;\n                &lt;\/exclusion&gt;\n                &lt;exclusion&gt;\n                    &lt;groupId&gt;io.swagger&lt;\/groupId&gt;\n                    &lt;artifactId&gt;swagger-models&lt;\/artifactId&gt;\n                &lt;\/exclusion&gt;\n            &lt;\/exclusions&gt;\n        &lt;\/dependency&gt;\n\n        &lt;!--\u9632\u6b62\u8fdb\u5165swagger\u9875\u9762\u62a5\u7c7b\u578b\u8f6c\u6362\u9519\u8bef\uff0c\u6392\u96642.9.2\u4e2d\u7684\u5f15\u7528\uff0c\u624b\u52a8\u589e\u52a01.5.21\u7248\u672c--&gt;\n        &lt;dependency&gt;\n            &lt;groupId&gt;io.swagger&lt;\/groupId&gt;\n            &lt;artifactId&gt;swagger-annotations&lt;\/artifactId&gt;\n            &lt;version&gt;1.5.21&lt;\/version&gt;\n        &lt;\/dependency&gt;\n\n        &lt;dependency&gt;\n            &lt;groupId&gt;io.swagger&lt;\/groupId&gt;\n            &lt;artifactId&gt;swagger-models&lt;\/artifactId&gt;\n            &lt;version&gt;1.5.21&lt;\/version&gt;\n        &lt;\/dependency&gt;\n\n        &lt;!-- swagger2-UI--&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;\n        &lt;dependency&gt;\n            &lt;groupId&gt;com.github.xiaoymin&lt;\/groupId&gt;\n            &lt;artifactId&gt;knife4j-spring-boot-starter&lt;\/artifactId&gt;\n            &lt;version&gt;2.0.2&lt;\/version&gt;\n        &lt;\/dependency&gt;<\/code><\/pre>\n\n\n\n<p>\u4e8c\u3001swagger\u914d\u7f6e<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>\/\/ SwaggerConfig \u6587\u4ef6\u914d\u7f6e\nimport com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;\nimport org.springframework.context.annotation.Bean;\nimport org.springframework.context.annotation.Configuration;\nimport org.springframework.context.annotation.Import;\nimport org.springframework.web.servlet.config.annotation.WebMvcConfigurer;\nimport springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration;\nimport springfox.documentation.builders.ApiInfoBuilder;\nimport springfox.documentation.builders.PathSelectors;\nimport springfox.documentation.builders.RequestHandlerSelectors;\nimport springfox.documentation.service.ApiInfo;\nimport springfox.documentation.service.ApiKey;\nimport springfox.documentation.service.AuthorizationScope;\nimport springfox.documentation.service.SecurityReference;\nimport springfox.documentation.spi.DocumentationType;\nimport springfox.documentation.spi.service.contexts.SecurityContext;\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 \/\/ \u58f0\u660e\u4e3a\u914d\u7f6e\u6587\u4ef6\uff0c\u8ba9spring\u52a0\u8f7d\n@EnableSwagger2 \/\/ \u652f\u6301swagger2\u63d2\u4ef6\u914d\u7f6e\n@EnableKnife4j\n@Import(BeanValidatorPluginsConfiguration.class)\npublic class SwaggerConfig implements WebMvcConfigurer {\n\n    \/\/ apiInfo\u5bf9\u8c61\u4e3b\u8981\u662f\u8bbe\u7f6e\u6211\u4eecapi\u6587\u6863\u7684\u6807\u9898\uff0c\u63cf\u8ff0\uff0c\u8bbf\u95ee\u7684\u5730\u5740\uff0c\u521b\u5efa\u8005\u7b49\u4fe1\u606f\n    @SuppressWarnings(\"deprecation\")\n    @Bean\n    public ApiInfo apiInfo() {\n        return new ApiInfoBuilder()\n                .title(\"Api\u63a5\u53e3\u6587\u6863\")\n                .description(\"\u5feb\u901f\u8fdb\u884cApi\u63a5\u53e3\u8c03\u8bd5\")\n\/\/                .termsOfServiceUrl(\"127.0.0.1:8089\")\n                .contact(\"Admin\")\n                .version(\"1.0\")\n                .build();\n    }\n\n    \/**\n     * \u521b\u5efaAPI\n     *\/\n    @Bean\n    public Docket createRestApi() {\n        return new Docket(DocumentationType.SWAGGER_2)\n                \/\/ .pathMapping(\"\/dev-api\")\n                \/\/ \u7528\u6765\u521b\u5efa\u8be5API\u7684\u57fa\u672c\u4fe1\u606f\uff0c\u5c55\u793a\u5728\u6587\u6863\u7684\u9875\u9762\u4e2d\uff08\u81ea\u5b9a\u4e49\u5c55\u793a\u7684\u4fe1\u606f\uff09\n                .apiInfo(apiInfo())\n                \/\/ \u8bbe\u7f6e\u54ea\u4e9b\u63a5\u53e3\u66b4\u9732\u7ed9Swagger\u5c55\u793a\n                .select()\n                \/\/ \u626b\u63cf\u6240\u6709\u6709\u6ce8\u89e3\u7684api\uff0c\u7528\u8fd9\u79cd\u65b9\u5f0f\u66f4\u7075\u6d3b\n                \/\/ .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))\n                \/\/ \u626b\u63cf\u6307\u5b9a\u5305\u4e2d\u7684swagger\u6ce8\u89e3\n                .apis(RequestHandlerSelectors.basePackage(\"com.basic.pub.swam.controller\"))\n                \/\/ \u626b\u63cf\u6240\u6709 .apis(RequestHandlerSelectors.any())\n                .paths(PathSelectors.any()).build()\n                \/* \u8bbe\u7f6e\u5b89\u5168\u6a21\u5f0f\uff0cswagger\u53ef\u4ee5\u8bbe\u7f6e\u8bbf\u95eetoken *\/\n                .securitySchemes(securitySchemes()).securityContexts(securityContexts());\n    }\n\n    \/**\n     * \u5b89\u5168\u6a21\u5f0f\uff0c\u8fd9\u91cc\u6307\u5b9atoken\u901a\u8fc7Authorization\u5934\u8bf7\u6c42\u5934\u4f20\u9012\n     *\/\n    private List&lt;ApiKey&gt; securitySchemes() {\n        List&lt;ApiKey&gt; apiKeyList = new ArrayList&lt;ApiKey&gt;();\n        apiKeyList.add(new ApiKey(\"Authorization\", \"Authorization\", \"header\"));\n        apiKeyList.add(new ApiKey(\"token\", \"token\", \"header\"));\n        return apiKeyList;\n    }\n\n    \/**\n     * \u5b89\u5168\u4e0a\u4e0b\u6587\n     *\/\n    private List&lt;SecurityContext&gt; securityContexts() {\n        List&lt;SecurityContext&gt; securityContexts = new ArrayList&lt;&gt;();\n        securityContexts.add(SecurityContext.builder().securityReferences(defaultAuth())\n                .forPaths(PathSelectors.regex(\"^(?!auth).*$\")).build());\n        return securityContexts;\n    }\n\n    \/**\n     * \u9ed8\u8ba4\u7684\u5b89\u5168\u4e0a\u5f15\u7528\n     *\/\n    private List&lt;SecurityReference&gt; defaultAuth() {\n        AuthorizationScope authorizationScope = new AuthorizationScope(\"global\", \"accessEverything\");\n        AuthorizationScope&#91;] authorizationScopes = new AuthorizationScope&#91;1];\n        authorizationScopes&#91;0] = authorizationScope;\n        List&lt;SecurityReference&gt; securityReferences = new ArrayList&lt;&gt;();\n        securityReferences.add(new SecurityReference(\"Authorization\", authorizationScopes));\n        return securityReferences;\n    }\n}\n\n\/\/ \u5728\u542f\u52a8\u7c7bspringApplication\u4e2d\u589e\u52a0@EnableSwagger2\n@SpringBootApplication\n@EnableDiscoveryClient\n@EnableSwagger2\n@Slf4j\n\/\/@MapperScan(\"com.basic.pub.swam.mapper\")\n@EnableScheduling\npublic class PublicServerApplication\n\n<\/code><\/pre>\n\n\n\n<p>\u4e09\u3001\u4f7f\u7528swagger<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>controller: @ApiOperation(notes = \"XX\",value = \"xx\",httpMethod = \"post\")<\/code><\/pre>\n","raw":"","protected":false},"excerpt":{"rendered":"<p>\u4e00\u3001\u5f15\u5165knife4j\u5bf9\u5e94jar\u5305 \u4e8c\u3001swagger\u914d\u7f6e \u4e09\u3001\u4f7f\u7528swagger<\/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":[7],"tags":[],"class_list":["post-96","post","type-post","status-publish","format-standard","hentry","category-spring-boot"],"post_thumbnail_image":"","content_first_image":null,"post_medium_image_300":"","post_thumbnail_image_624":"","post_frist_image":null,"post_medium_image":"","post_large_image":"","post_full_image":"","post_all_images":[],"videoAdId":"","listAd":"0","listAdId":"","listAdEvery":6,"total_comments":0,"category_name":"Spring Boot","post_date":"2022-11-03","like_count":"1","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":[{"avatarurl":"https:\/\/wp-moto-1258805347.cos.ap-shanghai.myqcloud.com\/2023\/05\/20230525140221253.jpg"}],"related_posts":null,"pageviews":297,"next_post_id":569,"next_post_title":"SpringBoot\u5b9e\u73b0\u52a8\u6001\u5bfc\u51faword\u6587\u6863","previous_post_id":4353,"previous_post_title":"Spring Boot\u6574\u5408WebSocket\u5b9e\u73b0\u5b9e\u65f6\u6d88\u606f\u63a8\u9001","_links":{"self":[{"href":"https:\/\/xinchewhd.com.cn\/index.php\/wp-json\/wp\/v2\/posts\/96","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=96"}],"version-history":[{"count":1,"href":"https:\/\/xinchewhd.com.cn\/index.php\/wp-json\/wp\/v2\/posts\/96\/revisions"}],"predecessor-version":[{"id":3750,"href":"https:\/\/xinchewhd.com.cn\/index.php\/wp-json\/wp\/v2\/posts\/96\/revisions\/3750"}],"wp:attachment":[{"href":"https:\/\/xinchewhd.com.cn\/index.php\/wp-json\/wp\/v2\/media?parent=96"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/xinchewhd.com.cn\/index.php\/wp-json\/wp\/v2\/categories?post=96"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/xinchewhd.com.cn\/index.php\/wp-json\/wp\/v2\/tags?post=96"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}