{"id":8188,"date":"2023-11-28T20:18:04","date_gmt":"2023-11-28T12:18:04","guid":{"rendered":"https:\/\/wx.kaifamiao.info\/?p=8188"},"modified":"2023-12-06T10:06:35","modified_gmt":"2023-12-06T02:06:35","slug":"springboot-zhong-qian-hou-duan-fen-li-ru-he-wei-hu","status":"publish","type":"post","link":"http:\/\/wx.kaifamiao.info\/index.php\/2023\/11\/28\/springboot-zhong-qian-hou-duan-fen-li-ru-he-wei-hu\/","title":{"rendered":"SpringBoot\u4e2d\u524d\u540e\u7aef\u5206\u79bb\uff0c\u5982\u4f55\u7ef4\u62a4\u63a5\u53e3\u6587\u6863\uff1f"},"content":{"rendered":"

\u5728\u524d\u540e\u7aef\u5206\u79bb\u7684Spring Boot\u5e94\u7528\u4e2d\uff0c\u7ef4\u62a4\u63a5\u53e3\u6587\u6863\u662f\u975e\u5e38\u91cd\u8981\u7684\uff0c\u56e0\u4e3a\u5b83\u80fd\u591f\u5e2e\u52a9\u524d\u7aef\u5f00\u53d1\u8005\u7406\u89e3\u540e\u7aefAPI\u7684\u8bbe\u8ba1\u548c\u4f7f\u7528\u65b9\u5f0f\u3002\u4ee5\u4e0b\u662f\u4e00\u4e9b\u5e38\u7528\u7684\u65b9\u5f0f\u6765\u7ef4\u62a4\u63a5\u53e3\u6587\u6863\uff1a<\/p>\n

    \n
  1. \nSwagger\uff08Springfox\uff09\uff1a<\/strong> Swagger\u662f\u4e00\u79cd\u5e38\u7528\u7684API\u6587\u6863\u5de5\u5177\uff0cSpring Boot\u4e2d\u6709\u4e0e\u4e4b\u96c6\u6210\u7684Springfox\u5e93\u3002\u901a\u8fc7\u4f7f\u7528Springfox\uff0c\u4f60\u53ef\u4ee5\u901a\u8fc7\u6ce8\u89e3\u7684\u65b9\u5f0f\u63cf\u8ff0API\uff0c\u5e76\u751f\u6210\u5177\u6709\u4ea4\u4e92\u5f0fUI\u7684API\u6587\u6863\u3002\u5728pom.xml<\/code>\u4e2d\u6dfb\u52a0\u4ee5\u4e0b\u4f9d\u8d56\uff1a<\/p>\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
    \u521b\u5efa\u4e00\u4e2aSwagger\u914d\u7f6e\u7c7b\uff0c\u4f8b\u5982\uff1a<\/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\n    @Bean\n    public Docket api() {\n        return new Docket(DocumentationType.SWAGGER_2)\n                .select()\n                .apis(RequestHandlerSelectors.basePackage("your.api.package"))\n                .paths(PathSelectors.any())\n                .build();\n    }\n}\n<\/code><\/pre>\n
    \u8bbf\u95eehttp:\/\/localhost:8080\/swagger-ui\/<\/code>\u5373\u53ef\u67e5\u770b\u751f\u6210\u7684API\u6587\u6863\u3002\n<\/li>\n
  2. \nPostman\u6216\u5176\u4ed6API\u5de5\u5177\uff1a<\/strong> \u4f7f\u7528Postman\u7b49API\u5f00\u53d1\u5de5\u5177\uff0c\u4f60\u53ef\u4ee5\u521b\u5efa\u548c\u5206\u4eabAPI\u8bf7\u6c42\u96c6\u5408\uff0c\u5e76\u6dfb\u52a0\u8bf7\u6c42\u548c\u54cd\u5e94\u7684\u63cf\u8ff0\uff0c\u4ee5\u4fbf\u6574\u7406\u548c\u7ef4\u62a4API\u6587\u6863\u3002Postman\u8fd8\u63d0\u4f9b\u4e86\u751f\u6210\u6587\u6863\u7684\u529f\u80fd\uff0c\u53ef\u4ee5\u751f\u6210HTML\u683c\u5f0f\u7684\u6587\u6863\u3002\n<\/li>\n
  3. \n\u624b\u52a8\u7ef4\u62a4Markdown\u6587\u6863\uff1a<\/strong> \u4f60\u4e5f\u53ef\u4ee5\u9009\u62e9\u624b\u52a8\u7f16\u5199Markdown\u6587\u6863\uff0c\u63cf\u8ff0API\u7684\u8bf7\u6c42\u548c\u54cd\u5e94\uff0c\u4ee5\u53ca\u76f8\u5173\u7684\u6ce8\u610f\u4e8b\u9879\u3002\u8fd9\u79cd\u65b9\u5f0f\u7b80\u5355\u76f4\u63a5\uff0c\u9002\u7528\u4e8e\u5c0f\u578b\u9879\u76ee\u6216\u8005\u5bf9\u81ea\u52a8\u5316\u6587\u6863\u751f\u6210\u8981\u6c42\u4e0d\u9ad8\u7684\u573a\u666f\u3002\n<\/li>\n
  4. \n\u5728\u7ebf\u6587\u6863\u5e73\u53f0\uff1a<\/strong> \u4f7f\u7528\u5728\u7ebf\u6587\u6863\u5e73\u53f0\u5982GitBook\u3001Confluence\u7b49\uff0c\u53ef\u4ee5\u5728\u5e73\u53f0\u4e0a\u521b\u5efa\u548c\u7ef4\u62a4\u63a5\u53e3\u6587\u6863\uff0c\u65b9\u4fbf\u4e0e\u56e2\u961f\u534f\u4f5c\u548c\u5206\u4eab\u3002\n<\/li>\n<\/ol>\n
    \u9009\u62e9\u5408\u9002\u7684\u65b9\u5f0f\u53d6\u51b3\u4e8e\u4f60\u7684\u56e2\u961f\u548c\u9879\u76ee\u7684\u5b9e\u9645\u9700\u6c42\u3002Swagger\u662f\u4e00\u4e2a\u5f3a\u5927\u7684\u5de5\u5177\uff0c\u7279\u522b\u9002\u7528\u4e8e\u751f\u6210\u4ea4\u4e92\u5f0f\u7684API\u6587\u6863\uff0c\u4f46\u4f60\u4e5f\u53ef\u4ee5\u9009\u62e9\u5176\u4ed6\u65b9\u5f0f\u6765\u6ee1\u8db3\u56e2\u961f\u7684\u9700\u8981\u3002<\/p>\n","protected":false},"excerpt":{"rendered":"
    \u5728\u524d\u540e\u7aef\u5206\u79bb\u7684Spring Boot\u5e94\u7528\u4e2d\uff0c\u7ef4\u62a4\u63a5\u53e3\u6587\u6863\u662f\u975e\u5e38\u91cd\u8981\u7684\uff0c\u56e0\u4e3a\u5b83\u80fd\u591f\u5e2e\u52a9\u524d\u7aef\u5f00\u53d1\u8005\u7406\u89e3\u540e\u7aefAPI\u7684 […]<\/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-8188","post","type-post","status-publish","format-standard","hentry","category-springboot"],"_links":{"self":[{"href":"http:\/\/wx.kaifamiao.info\/index.php\/wp-json\/wp\/v2\/posts\/8188","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=8188"}],"version-history":[{"count":2,"href":"http:\/\/wx.kaifamiao.info\/index.php\/wp-json\/wp\/v2\/posts\/8188\/revisions"}],"predecessor-version":[{"id":16583,"href":"http:\/\/wx.kaifamiao.info\/index.php\/wp-json\/wp\/v2\/posts\/8188\/revisions\/16583"}],"wp:attachment":[{"href":"http:\/\/wx.kaifamiao.info\/index.php\/wp-json\/wp\/v2\/media?parent=8188"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"http:\/\/wx.kaifamiao.info\/index.php\/wp-json\/wp\/v2\/categories?post=8188"},{"taxonomy":"post_tag","embeddable":true,"href":"http:\/\/wx.kaifamiao.info\/index.php\/wp-json\/wp\/v2\/tags?post=8188"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}