{"id":636,"date":"2024-10-14T13:54:59","date_gmt":"2024-10-14T05:54:59","guid":{"rendered":"https:\/\/fugary.com\/?p=636"},"modified":"2024-10-14T16:30:33","modified_gmt":"2024-10-14T08:30:33","slug":"%e7%ae%80%e5%8d%95api%e6%96%87%e6%a1%a3%e6%9c%8d%e5%8a%a1%e5%8f%91%e5%b8%83","status":"publish","type":"post","link":"https:\/\/fugary.com\/?p=636","title":{"rendered":"\u7b80\u5355API\u6587\u6863\u670d\u52a1\u53d1\u5e03"},"content":{"rendered":"

\u6700\u8fd1\u4f7f\u7528\u65b0OpenAPI<\/code>\u63a5\u53e3\u65f6\u53d1\u73b0\u81ea\u5e26\u7684SwaggerUI<\/code>\u754c\u9762\u4e0d\u662f\u5f88\u53cb\u597d\uff0c\u4e00\u4e9b\u5f00\u6e90\u7684\u5e93\uff0c\u5982Knife4j<\/code>\u4f7f\u7528\u867d\u7136\u5f88\u65b9\u4fbf\uff0c\u4e0d\u8fc7\u5bf9\u4e8e\u6bd4\u8f83\u5927\u7684schema<\/code>\u652f\u6301\u4e0d\u597d\uff0c\u5bb9\u6613\u51fa\u73b0\u5361\u987f\uff0c\u76ee\u524d\u505a\u7684\u6bd4\u8f83\u597d\u7684\u662fApiFox<\/code>\uff0c\u4e0d\u8fc7\u4e0d\u80fd\u540c\u6b65Markdown<\/code>\u6587\u4ef6\uff0c\u800c\u4e14\u79c1\u6709\u5316\u90e8\u7f72\u9700\u8981\u53e6\u5916\u6536\u8d39\u3002<\/p>\n

\u5176\u5b9eAPI<\/code>\u6587\u6863\u670d\u52a1\u6bd4\u8f83\u7b80\u5355\uff0c\u6ca1\u6709\u592a\u591a\u529f\u80fd\uff0c\u56e0\u6b64\u62bd\u7a7a\u81ea\u5df1\u5f00\u53d1\u4e00\u4e2a\u7b80\u5355\u7684API\u6587\u6863\u7cfb\u7edf<\/p>\n

\u529f\u80fd\u4ecb\u7ecd<\/h3>\n

\u7531\u4e00\u4e2aJava<\/code>\u540e\u7aef\u548cVue3<\/code>\u524d\u7aef\u7ec4\u6210\uff0c\u4e3b\u8981\u529f\u80fd\u5982\u4e0b\uff1a<\/p>\n

    \n
  1. \u4eceSwagger<\/code>\u6216\u8005OpenAPI<\/code>\u7684\u6587\u6863\uff08json\/yaml<\/code>)\u6587\u4ef6\u6216URL<\/code>\u8def\u5f84\u5bfc\u5165\u6587\u6863\u7cfb\u7edf<\/li>\n
  2. \u652f\u6301\u67e5\u770bMarkdown<\/code>\u6587\u6863\u548cAPI<\/code>\u6587\u6863\u5b57\u6bb5\u7b49<\/li>\n
  3. \u652f\u6301\u65b0\u589eMarkdown<\/code>\u6587\u6863\uff0c\u65b9\u4fbf\u5bf9OpenAPI<\/code>\u6587\u6863\u505a\u4e00\u4e9b\u9644\u52a0\u8bf4\u660e\u7b49<\/li>\n
  4. \u652f\u6301\u5206\u4eab\u94fe\u63a5\u548c\u5bc6\u7801\u67e5\u770b\uff0c\u652f\u6301\u5206\u4eab\u6709\u6548\u671f<\/li>\n
  5. \u652f\u6301\u5b9a\u65f6\u4ece\u6307\u5b9aURL<\/code>\u6293\u53d6\u6587\u6863\u6570\u636e<\/li>\n
  6. \u652f\u6301\u5728\u7ebf\u8c03\u8bd5\u63a5\u53e3\u8bf7\u6c42<\/li>\n
  7. \u652f\u6301\u591a\u7ea7\u6587\u4ef6\u5939\u5c55\u793aAPI<\/code>\u6587\u6863<\/li>\n<\/ol>\n

    \u5b9e\u73b0\u6280\u672f\u6808<\/h3>\n

    \u57fa\u4e8eSpring Boot<\/code>\u5f00\u53d1\u7684\u6587\u6863\u670d\u52a1\u5668\uff0c\u4e3b\u8981\u8981\u4e24\u4e2a\u9879\u76ee\uff1a<\/p>\n

      \n
    1. \u540e\u53f0\u670d\u52a1simple-api-doc<\/code><\/li>\n
    2. UI<\/code>\u754c\u9762simple-api-doc-ui<\/code>\uff08Vue3<\/code>\uff09<\/li>\n<\/ol>\n

      \u6700\u540e\u6253\u5305\u7684\u65f6\u5019\u5408\u5e76\u5230\u4e00\u4e2a\u9879\u76ee\u4e2d\uff0c\u6210\u4e3a\u4e00\u4e2ajar<\/code>\u5305\uff0c\u6700\u540e\u6253\u5305\u6210\u4e3a\u4e00\u4e2azip<\/code>\u6587\u4ef6\uff0c\u52a0\u538b\u8fd0\u884c\u5373\u53ef\u3002<\/p>\n

      \u6e90\u7801\uff1ahttps:\/\/github.com\/fugary\/simple-api-doc<\/a><\/p>\n

      \u540e\u7aef\u6846\u67b6<\/h4>\n
        \n
      1. Spring Boot<\/code><\/li>\n
      2. Mybatis<\/code>\u3001MybatisPlus<\/code><\/li>\n
      3. Lombok<\/code><\/li>\n
      4. Logback<\/code><\/li>\n
      5. FlywayDB<\/code><\/li>\n
      6. swagger-parser<\/code><\/li>\n<\/ol>\n

        \u524d\u7aef\u7cfb\u7edf<\/h4>\n

        \u57fa\u4e8e\u81ea\u5df1\u5bf9element-plus<\/code>\u7684\u4e8c\u6b21\u5c01\u88c5\uff1ahttps:\/\/github.com\/fugary\/simple-element-plus-template<\/a><\/p>\n

          \n
        1. Vue3<\/code>\u5168\u5bb6\u6876<\/li>\n
        2. element-plus<\/code><\/li>\n
        3. dayjs<\/code><\/li>\n
        4. lodash-es<\/code><\/li>\n
        5. monaco-editor<\/code><\/li>\n
        6. md-editor-v3<\/code>\u7f16\u8f91Markdown<\/code>\u7f16\u8f91\u5668<\/li>\n
        7. markdown-it<\/code><\/li>\n<\/ol>\n

          \u5b89\u88c5\u542f\u52a8<\/h3>\n

          \u5f00\u6e90\u5730\u5740\uff1ahttps:\/\/github.com\/fugary\/simple-api-doc<\/a><\/p>\n

          \u89e3\u538b\u542f\u52a8<\/h4>\n

          \u627e\u5230https:\/\/github.com\/fugary\/simple-api-doc\/releases<\/p>\n

          \u4e0b\u8f7d\u6700\u65b0\u7248\u672c\u540e\u89e3\u538b<\/p>\n

          \"image-20241014134326114\"<\/div><\/p>\n

          \u8fdb\u5165bin<\/code>\u76ee\u5f55<\/p>\n

          \"image-20241014101144382\"<\/div><\/p>\n

          \u70b9\u51fbstart.bat<\/code>\u542f\u52a8\u540e\u53ef\u4ee5\u8fdb\u5165\u767b\u5f55\u9875\u9762\uff1ahttp:\/\/localhost:9089\/<\/a><\/p>\n

          \"image-20241014131105697\"<\/div><\/p>\n

          \u5982\u679c\u8981\u652f\u6301MySQL<\/code>\u9700\u8981\u63d0\u524d\u914d\u7f6eMySQL<\/code>\u6570\u636e\u5e93\u4fe1\u606f\u3002<\/p>\n

          Docker\u542f\u52a8<\/h4>\n

          docker<\/code>\u8fd0\u884c\u6bd4\u8f83\u7b80\u5355\uff0c\u53ea\u8981\u5df2\u7ecf\u5b89\u88c5\u597ddocker<\/code>\uff0c\u76f4\u63a5\u4f7f\u7528\u547d\u4ee4\u5c31\u53ef\u4ee5\u81ea\u52a8\u62c9\u53bb\u955c\u50cf\u5e76\u8fd0\u884c\u4e86<\/p>\n

          docker run -p 9089:9089 fugary\/simple-api-doc:latest<\/code><\/pre>\n
          \u5e38\u89c4\u4f7f\u7528<\/h3>\n
          \u7cfb\u7edf\u540e\u53f0\u7ba1\u7406API<\/code>\u63a5\u53e3\uff0c\u901a\u8fc7\u5206\u4eab\u94fe\u63a5\u7684\u5f62\u5f0f\u63d0\u4f9b\u7ed9\u5ba2\u6237<\/p>\n
          \u4fee\u6539\u5bc6\u7801<\/h4>\n
          \u542f\u52a8\u540e\u8fdb\u5165\u7cfb\u7edf\uff0c\u767b\u5f55\u8d26\u53f7admin\/12345678<\/code>\uff0c\u767b\u5f55\u7cfb\u7edf\u540e\u5c3d\u5feb\u8fdb\u5165\u3010\u4e2a\u4eba\u8d44\u6599\u3011\u4fee\u6539\u5bc6\u7801<\/p>\n
          \"image-20241014131202957\"<\/div><\/p>\n
          \u5bfc\u5165\u6570\u636e<\/h4>\n
          \u70b9\u51fb\u3010\u5bfc\u5165\u6570\u636e\u3011\uff0c\u9009\u62e9\u9700\u8981\u5bfc\u5165\u7684json<\/code>\u6216yaml<\/code>\u6587\u4ef6\uff0c\u6216\u8005\u6307\u5b9a\u7684URL<\/code>\u5730\u5740\uff0c\u5982\u679c\u9700\u8981\u8ba4\u8bc1\u7684\u8bdd\u53ef\u4ee5\u6839\u636e\u5b9e\u9645\u60c5\u51b5\u53bb\u586b\u5199\u4fe1\u606f\uff0c\u652f\u6301Basic<\/code>\u548cToken<\/code>\u8ba4\u8bc1\u65b9\u5f0f\u3002<\/p>\n
          \u8fd9\u91cc\u4ee5OpanAI\u7684\u63a5\u53e3\u4e3a\u4f8b\uff1a<\/p>\n
          https:\/\/raw.githubusercontent.com\/openai\/openai-openapi\/refs\/heads\/master\/openapi.yaml<\/a><\/p>\n
          \u8fd9\u4e2a\u5730\u5740\u4e0d\u80fd\u76f4\u63a5\u8bbf\u95ee\uff0c\u53ef\u80fd\u9700\u8981\u4ee3\u7406\u4e0b\u8f7d\u4e0b\u6765\u540e\u4f7f\u7528\uff0c\u6216\u8005\u7528\u4ee3\u7406\u5de5\u5177\uff1a<\/p>\n
          https:\/\/mirror.ghproxy.com\/https:\/\/raw.githubusercontent.com\/openai\/openai-openapi\/refs\/heads\/master\/openapi.yaml<\/a><\/p>\n
          \"image-20241014131430456\"<\/div><\/p>\n
          \u5bfc\u5165\u540e\u53ef\u4ee5\u67e5\u770b\u6587\u6863\u8be6\u60c5\uff1a<\/p>\n
          \"image-20241014131550112\"<\/div><\/p>\n
          \u5de6\u4fa7\u6587\u4ef6\u5939\u533a\u57df<\/strong>\uff0c\u6309\u7167Tag<\/code>\u4f5c\u4e3a\u6587\u4ef6\u5939\u5c55\u793a\uff0c\u53f3\u4fa7\u662f\u4e3b\u6587\u6863\u533a\u57df<\/strong>\uff0c\u53ef\u4ee5\u5206\u4eab\u6587\u6863<\/strong>\uff0c\u5bfc\u5165\u6570\u636e<\/strong>\uff0c\u8c03\u8bd5\u63a5\u53e3<\/strong>\u7b49<\/p>\n
          \u6587\u6863\u5206\u4eab<\/h4>\n
          \u5bfc\u5165\u7684\u6587\u6863\u5e76\u4e0d\u662f\u76f4\u63a5\u5bf9\u5916\u5f00\u653e\uff0c\u9700\u8981\u65b0\u5efa\u4e00\u4e2a\u3010\u6587\u6863\u5206\u4eab\u3011\uff0c\u901a\u8fc7\u6587\u6863\u5206\u4eab\u94fe\u63a5\u63d0\u4f9b\u7ed9\u7b2c\u4e09\u65b9\u5ba2\u6237\uff0c\u652f\u6301\u5bc6\u7801\u548c\u6709\u6548\u671f\u63a7\u5236<\/p>\n
          \u8fdb\u5165\u3010\u6587\u6863\u5206\u4eab\u3011\u9875\u9762\uff0c\u70b9\u51fb\u3010\u65b0\u589e\u3011\u6309\u94ae\uff0c\u586b\u5199\u5206\u4eab\u4fe1\u606f\uff0c\u53ef\u4ee5\u586b\u5199\u540d\u79f0\uff0c\u4ee5\u53ca\u4e00\u4e9b\u5e38\u7528\u914d\u7f6e\u4fe1\u606f\uff1a<\/p>\n
          \"image-20241014131847263\"<\/div><\/p>\n
          \u65b0\u5efa\u597d\u4e4b\u540e\u5c31\u6709\u4e00\u4e2a\u5206\u4eab\u94fe\u63a5\uff0c\u53ef\u4ee5\u628a\u94fe\u63a5\u7ed9\u5230\u7b2c\u4e09\u65b9\u4f7f\u7528\uff1a<\/p>\n
          \"image-20241014131958052\"<\/div><\/p>\n
          \u5206\u4eab\u67e5\u770b<\/h4>\n
          \u590d\u5236\u597d\u5206\u4eab\u94fe\u63a5\u6216\u8005\u76f4\u63a5\u4ece\u5206\u4eab\u5217\u8868\u9875\u70b9\u51fb\u53ef\u4ee5\u8df3\u8f6c\u5230\u5206\u4eab\u9875\u9762\uff0c\u5206\u4eab\u9875\u9762\u53ef\u4ee5\u3010\u8c03\u8bd5\u63a5\u53e3\u3011\uff0c\u4e0b\u8f7dSwagger<\/code>\u652f\u6301\u7684json<\/code>\u6216\u8005yaml<\/code>\u63a5\u53e3\u6587\u6863<\/p>\n
          \"image-20241014132042746\"<\/div><\/p>\n
          \u53f3\u4fa7\u662f\u8bf7\u6c42\u4f53\u6216\u54cd\u5e94\u4f53\u8be6\u7ec6\u6587\u6863\u4fe1\u606f<\/p>\n
          \"image-20241014134412817\"<\/div><\/p>\n
          \u63a5\u53e3\u8c03\u8bd5<\/h4>\n
          \u76ee\u524d\u652f\u6301\u7b80\u5355\u7684\u63a5\u53e3\u8c03\u8bd5\u529f\u80fd\uff0c\u70b9\u51fb\u3010\u8c03\u8bd5\u63a5\u53e3\u3011\uff0c\u5f39\u51fa\u7684\u65b0\u7a97\u53e3\u53ef\u4ee5\u9009\u62e9\u3010\u53d1\u9001\u8bf7\u6c42\u3011<\/p>\n
          \"image-20241014162727697\"<\/div><\/p>\n
          \u9ad8\u7ea7\u529f\u80fd<\/h3>\n
          \u5b9a\u65f6\u5bfc\u5165<\/h4>\n
          \"image-20241014134919210\"<\/div><\/p>\n
          \u5b9a\u65f6\u5bfc\u5165\u53ea\u652f\u6301\u4eceURL<\/code>\u6293\u53d6\u6570\u636e\uff0c\u914d\u7f6e\u4e00\u4e9b\u5b9a\u65f6\u76f8\u5173\u4fe1\u606f\u5373\u53ef\uff1a<\/p>\n
          \"image-20241014135038225\"<\/div><\/p>\n
          \u591a\u7ea7\u6587\u4ef6\u5939<\/h4>\n
          SwaggerUI<\/code>\u4e0d\u652f\u6301\u591a\u7ea7\u6587\u4ef6\u5939\uff0c\u90fd\u662f\u5e73\u94fa\u5c55\u5f00\uff0c\u4ec5\u7528Tag<\/code>\u5206\u7ec4\uff0c\u56e0\u6b64\u6269\u5c55OpenAPI<\/code>\u8f93\u51fa\u683c\u5f0f\u6dfb\u52a0\u6269\u5c55\u5c5e\u6027x-simple-folder<\/code>\uff0c\u53ef\u4ee5\u652f\u6301\u591a\u7ea7\u6587\u4ef6\u5939\uff1a<\/p>\n
          "\/get": {\n      "post": {\n          "operationId": "get",   \n          "x-simple-folder": "\u6587\u4ef6\u59391\/\u6587\u4ef6\u59392"\n      }\n  }<\/code><\/pre>\n
          \u6ce8\u89e3\u914d\u7f6e\u5982\u4e0b\uff1a<\/p>\n
          @Operation(extensions = {\n    @Extension(properties = {\n            @ExtensionProperty(name = "x-simple-folder", value = "\u6587\u4ef6\u59391\/\u6587\u4ef6\u59392")})\n})\npublic ResponseEntity<String> get() {\n\n}<\/code><\/pre>\n
          MD\u6587\u4ef6<\/h4>\n
          \u53e6\u5916\u6269\u5c55OpenAPI<\/code>\u8f93\u51fa\u683c\u5f0f\u6dfb\u52a0\u6269\u5c55\u5c5e\u6027x-simple-markdown-files<\/code>\uff0c\u901a\u8fc7JSON<\/code>\u6570\u7ec4\u65b9\u5f0f\u6dfb\u52a0markdown<\/code>\u6587\u4ef6\u6570\u636e\uff1a<\/p>\n
          \u793a\u4f8b\uff1a<\/p>\n
          "x-simple-markdown-files": [{\n    "fileName": "1-CreditCard.md",\n    "title": "\u4fe1\u7528\u5361\u5b89\u5168",\n    "content": "### \u4fe1\u7528\u5361\u5b89\u5168\\r\\n\\r\\n\u76ee\u524d`PCI DSS`\u8981\u6c42\u9664\u4e86\u63a5\u53e3\u4f7f\u7528`https`\u4e4b\u5916\uff0c\u4fe1\u7528\u5361\u5728\u5b9e\u9645\u4f20\u8f93\u8fc7\u7a0b\u4e2d\u4e5f\u9700\u8981\u52a0\u5bc6\u4f20\u8f93\uff0c\u4f7f\u7528\u5bf9\u79f0\u52a0\u5bc6\u7ea6\u5b9a\u5bc6\u7801\u7684\u65b9\u5f0f\u52a0\u5bc6\u540e\u4f20\u8f93\uff0c \u6536\u5230\u540e\u5728\u5ba2\u6237\u7aef\u6267\u884c\u89e3\u5bc6\u64cd\u4f5c\u3002\\r\\n\\r\\n#### \u52a0\u89e3\u5bc6\u7b97\u6cd5\\r\\n\\r\\n\u6211\u4eec\u4f7f\u7528AES256\u52a0\u5bc6\uff0c\u5e76\u4ee516\u8fdb\u5236\u683c\u5f0f\u8f93\u51fa\u4e3a\u6587\u672c\u3002\u52a0\u5bc6\u5bc6\u7801\u4e0e\u63a5\u53e3\u8bbf\u95ee\u5bc6\u7801\u76f8\u540c\uff0c\u5728\u4f20\u8f93\u524d\u5bf9\u8bf7\u6c42\u53c2\u6570\u76f8\u5173\u5b57\u6bb5\u8fdb\u884c\u52a0\u5bc6\uff0c\\r\\n\u6536\u5230\u54cd\u5e94\u7ed3\u679c\u540e\u5bf9\u76f8\u5173\u5b57\u6bb5\u89e3\u5bc6\u540e\u4f7f\u7528\u3002",\n    "sortId": 1\n}]<\/code><\/pre>\n
          \u4e3b\u9898\u5bf9\u8c61\u5982\u4e0b\uff1a<\/p>\n
          public class ExtendMarkdownFile implements Serializable {\n    private String fileName;\n    private String title;\n    private String content;\n    private Integer sortId;\n}<\/code><\/pre>\n
          \u5f85\u5f00\u53d1\u529f\u80fd<\/h3>\n
          \u8fd8\u6709\u4e9b\u53ef\u80fd\u9700\u8981\u5f00\u53d1\u7684\u529f\u80fd\uff0c\u76ee\u524d\u8fd8\u5728\u8003\u8651\u4e2d<\/p>\n
            \n
          1. \n
            \u6587\u4ef6\u5939\u590d\u5236\u3001\u79fb\u52a8\u7b49\u529f\u80fd<\/p>\n<\/li>\n
          2. \n
            \u90e8\u5206\u63a5\u53e3\u6587\u6863\u5bfc\u51fa\u3001\u5206\u4eab\u529f\u80fd<\/p>\n<\/li>\n
          3. \n
            API<\/code>\u5b9a\u4e49\u7f16\u8f91\u529f\u80fd\uff08\u76ee\u524d\u4ec5Markdown<\/code>\u6587\u6863\u53ef\u7f16\u8f91\uff0cAPI<\/code>\u4e00\u822c\u4ece\u5176\u4ed6\u7cfb\u7edf\u751f\u6210\u662f\u5426\u6709\u7f16\u8f91\u5fc5\u8981\uff09<\/p>\n<\/li>\n
          4. \n
            \u5b9a\u65f6\u6293\u53d6\u65e5\u5fd7\u67e5\u8be2\u529f\u80fd<\/p>\n<\/li>\n<\/ol>\n","protected":false},"excerpt":{"rendered":"
            \u6700\u8fd1\u4f7f\u7528\u65b0OpenAPI\u63a5\u53e3\u65f6\u53d1\u73b0\u81ea\u5e26\u7684SwaggerUI\u754c\u9762\u4e0d\u662f\u5f88\u53cb\u597d\uff0c\u4e00\u4e9b\u5f00\u6e90\u7684\u5e93\uff0c\u5982Knife4j\u4f7f\u7528\u867d […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":[],"categories":[5,4,14],"tags":[],"_links":{"self":[{"href":"https:\/\/fugary.com\/index.php?rest_route=\/wp\/v2\/posts\/636"}],"collection":[{"href":"https:\/\/fugary.com\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/fugary.com\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/fugary.com\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/fugary.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=636"}],"version-history":[{"count":4,"href":"https:\/\/fugary.com\/index.php?rest_route=\/wp\/v2\/posts\/636\/revisions"}],"predecessor-version":[{"id":641,"href":"https:\/\/fugary.com\/index.php?rest_route=\/wp\/v2\/posts\/636\/revisions\/641"}],"wp:attachment":[{"href":"https:\/\/fugary.com\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=636"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/fugary.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=636"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/fugary.com\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=636"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}