{"id":8156,"date":"2023-11-28T20:16:40","date_gmt":"2023-11-28T12:16:40","guid":{"rendered":"https:\/\/wx.kaifamiao.info\/?p=8156"},"modified":"2023-12-06T10:04:04","modified_gmt":"2023-12-06T02:04:04","slug":"springboot-zhong-ru-he-shi-xian-swagger","status":"publish","type":"post","link":"http:\/\/wx.kaifamiao.info\/index.php\/2023\/11\/28\/springboot-zhong-ru-he-shi-xian-swagger\/","title":{"rendered":"SpringBoot \u4e2d\u5982\u4f55\u5b9e\u73b0 Swagger?"},"content":{"rendered":"

Swagger\u662f\u4e00\u79cd\u7528\u4e8e\u8bbe\u8ba1\u3001\u6784\u5efa\u3001\u6587\u6863\u5316\u548c\u6d88\u8d39RESTful Web\u670d\u52a1\u7684\u5de5\u5177\u3002\u5728Spring Boot\u4e2d\uff0c\u4f60\u53ef\u4ee5\u4f7f\u7528Swagger2\u96c6\u6210\u5230\u4f60\u7684\u9879\u76ee\u4e2d\uff0c\u4ee5\u4fbf\u66f4\u8f7b\u677e\u5730\u521b\u5efa\u548c\u7ef4\u62a4API\u6587\u6863\u3002<\/p>\n

\u4ee5\u4e0b\u662f\u5728Spring Boot\u4e2d\u5b9e\u73b0Swagger\u7684\u4e00\u822c\u6b65\u9aa4\uff1a<\/p>\n

    \n
  1. \n\u6dfb\u52a0Swagger2\u4f9d\u8d56\uff1a<\/strong> \u5728pom.xml<\/code>\uff08\u5982\u679c\u4f7f\u7528Maven\uff09\u6216build.gradle<\/code>\uff08\u5982\u679c\u4f7f\u7528Gradle\uff09\u6587\u4ef6\u4e2d\uff0c\u6dfb\u52a0Swagger2\u7684\u4f9d\u8d56\u3002<\/p>\n
    <!-- Maven Dependency -->\n<dependency>\n    <groupId>io.springfox<\/groupId>\n    <artifactId>springfox-boot-starter<\/artifactId>\n    <version>3.0.0<\/version> <!-- \u8bf7\u4f7f\u7528\u6700\u65b0\u7248\u672c -->\n<\/dependency>\n<\/code><\/pre>\n
    \/\/ Gradle Dependency\nimplementation 'io.springfox:springfox-boot-starter:3.0.0' \/\/ \u8bf7\u4f7f\u7528\u6700\u65b0\u7248\u672c\n<\/code><\/pre>\n<\/li>\n
  2. \n\u914d\u7f6eSwagger2\uff1a<\/strong> \u521b\u5efa\u4e00\u4e2a\u914d\u7f6e\u7c7b\uff0c\u914d\u7f6eSwagger2\u3002<\/p>\n
    import org.springframework.context.annotation.Bean;\nimport org.springframework.context.annotation.Configuration;\nimport springfox.documentation.builders.PathSelectors;\nimport springfox.documentation.builders.RequestHandlerSelectors;\nimport springfox.documentation.spi.DocumentationType;\nimport springfox.documentation.spring.web.plugins.Docket;\nimport springfox.documentation.swagger2.annotations.EnableSwagger2;\n\n@Configuration\n@EnableSwagger2\npublic class SwaggerConfig {\n    @Bean\n    public Docket api() {\n        return new Docket(DocumentationType.SWAGGER_2)\n                .select()\n                .apis(RequestHandlerSelectors.basePackage("your.package.controller"))\n                .paths(PathSelectors.any())\n                .build();\n    }\n}\n<\/code><\/pre>\n
    \u8fd9\u4e2a\u914d\u7f6e\u7c7b\u4f7f\u7528@EnableSwagger2<\/code>\u6ce8\u89e3\u542f\u7528Swagger2\uff0c\u5e76\u5b9a\u4e49\u4e86\u4e00\u4e2aDocket<\/code> bean\uff0c\u8be5bean\u63cf\u8ff0\u4e86API\u7684\u57fa\u672c\u4fe1\u606f\uff0c\u5982\u626b\u63cf\u7684\u5305\u8def\u5f84\u7b49\u3002\n<\/li>\n
  3. \n\u8bbf\u95eeSwagger UI\uff1a<\/strong> \u542f\u52a8\u4f60\u7684Spring Boot\u5e94\u7528\uff0c\u7136\u540e\u8bbf\u95eeSwagger UI\u3002\u9ed8\u8ba4\u60c5\u51b5\u4e0b\uff0cSwagger UI\u7684\u5730\u5740\u662fhttp:\/\/localhost:8080\/swagger-ui\/<\/code>\u3002<\/p>\n
    \u8fd9\u4e2aUI\u754c\u9762\u5c06\u663e\u793a\u4f60\u7684API\u7684\u53ef\u7528\u7aef\u70b9\u3001\u8bf7\u6c42\u53c2\u6570\u3001\u54cd\u5e94\u4fe1\u606f\u7b49\uff0c\u4f7f\u5f97\u5f00\u53d1\u4eba\u5458\u53ef\u4ee5\u66f4\u5bb9\u6613\u5730\u4e86\u89e3\u548c\u6d4b\u8bd5API\u3002\n<\/li>\n<\/ol>\n
    \u8bf7\u6ce8\u610f\uff0c\u4e0a\u8ff0\u793a\u4f8b\u4e2d\u7684your.package.controller<\/code>\u5e94\u8be5\u66ff\u6362\u4e3a\u4f60\u5b9e\u9645\u63a7\u5236\u5668\u7684\u57fa\u5305\u8def\u5f84\u3002\u786e\u4fddSwagger\u53ea\u626b\u63cf\u4f60\u7684API\u63a7\u5236\u5668\u3002<\/p>\n
    \u53e6\u5916\uff0c\u5982\u679c\u4f60\u4f7f\u7528Spring Security\u7b49\u5b89\u5168\u6846\u67b6\uff0c\u4f60\u53ef\u80fd\u9700\u8981\u914d\u7f6eSwagger\u5141\u8bb8\u8bbf\u95ee\u5176\u7aef\u70b9\uff0c\u4ee5\u786e\u4fddSwagger UI\u80fd\u591f\u6b63\u5e38\u5de5\u4f5c\u3002\u8fd9\u901a\u5e38\u9700\u8981\u5728Spring Security\u914d\u7f6e\u4e2d\u653e\u884cSwagger\u7684\u76f8\u5173\u8def\u5f84\u3002<\/p>\n","protected":false},"excerpt":{"rendered":"
    Swagger\u662f\u4e00\u79cd\u7528\u4e8e\u8bbe\u8ba1\u3001\u6784\u5efa\u3001\u6587\u6863\u5316\u548c\u6d88\u8d39RESTful Web\u670d\u52a1\u7684\u5de5\u5177\u3002\u5728Spring Boot\u4e2d\uff0c […]<\/p>\n","protected":false},"author":9,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[100],"tags":[],"class_list":["post-8156","post","type-post","status-publish","format-standard","hentry","category-springboot"],"_links":{"self":[{"href":"http:\/\/wx.kaifamiao.info\/index.php\/wp-json\/wp\/v2\/posts\/8156","targetHints":{"allow":["GET"]}}],"collection":[{"href":"http:\/\/wx.kaifamiao.info\/index.php\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"http:\/\/wx.kaifamiao.info\/index.php\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"http:\/\/wx.kaifamiao.info\/index.php\/wp-json\/wp\/v2\/users\/9"}],"replies":[{"embeddable":true,"href":"http:\/\/wx.kaifamiao.info\/index.php\/wp-json\/wp\/v2\/comments?post=8156"}],"version-history":[{"count":2,"href":"http:\/\/wx.kaifamiao.info\/index.php\/wp-json\/wp\/v2\/posts\/8156\/revisions"}],"predecessor-version":[{"id":16579,"href":"http:\/\/wx.kaifamiao.info\/index.php\/wp-json\/wp\/v2\/posts\/8156\/revisions\/16579"}],"wp:attachment":[{"href":"http:\/\/wx.kaifamiao.info\/index.php\/wp-json\/wp\/v2\/media?parent=8156"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"http:\/\/wx.kaifamiao.info\/index.php\/wp-json\/wp\/v2\/categories?post=8156"},{"taxonomy":"post_tag","embeddable":true,"href":"http:\/\/wx.kaifamiao.info\/index.php\/wp-json\/wp\/v2\/tags?post=8156"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}