{"id":88881,"date":"2019-07-25T16:12:12","date_gmt":"2019-07-25T08:12:12","guid":{"rendered":"http:\/\/4563.org\/?p=88881"},"modified":"2019-07-25T16:12:12","modified_gmt":"2019-07-25T08:12:12","slug":"smart-doc-1-8-0-%e5%8f%91%e5%b8%83-java-%e9%9b%b6%e4%be%b5%e5%85%a5-api-%e6%96%87%e6%a1%a3%e7%94%9f%e6%88%90%e5%b7%a5%e5%85%b7","status":"publish","type":"post","link":"http:\/\/4563.org\/?p=88881","title":{"rendered":"smart-doc 1.8.0 \u53d1\u5e03 Java \u96f6\u4fb5\u5165 API \u6587\u6863\u751f\u6210\u5de5\u5177"},"content":{"rendered":"
\n
\n
\n

smart-doc 1.8.0 \u53d1\u5e03 Java \u96f6\u4fb5\u5165 API \u6587\u6863\u751f\u6210\u5de5\u5177 <\/h1>\n

<\/p>\n

\n
\u8cc7\u6df1\u5927\u4f6c : smartdoc647 <\/span> <\/i> 50<\/span> <\/div>\n
<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n
<\/p>\n

smart-doc \u662f\u4e00\u4e2a java restful api \u6587\u6863\u751f\u6210\u5de5\u5177\uff0csmart-doc \u5b8c\u5168\u57fa\u4e8e\u63a5\u53e3\u6e90\u7801\u5206\u6790\u6765\u751f\u6210\u63a5\u53e3\u6587\u6863\uff0c\u5b8c\u5168\u505a\u5230\u96f6\u6ce8\u89e3\u4fb5\u5165\uff0c\u4f60\u53ea\u9700\u8981\u5199\u4e0a java \u7684\u6807\u51c6\u6ce8\u91ca\uff0csmart-doc \u5c31\u80fd\u5e2e\u4f60\u751f\u6210\u4e00\u4e2a\u7b80\u6613\u660e\u4e86\u7684 Markdown\u3001Html\u3001AsciiDoc \u6587\u6863\u548c Postman json \u4e00\u952e\u5bfc\u5165\u7684\u6d4b\u8bd5\u6570\u636e\u3002\u5982\u679c\u4f60\u4e0d\u559c\u6b22\u5176\u4ed6\u5de5\u5177\u5f3a\u4fb5\u5165\u7684\u6ce8\u89e3\u6c61\u67d3\uff0csmart-doc \u7ed9\u4f60\u4e00\u4e2a\u4e0d\u9519\u7684\u9009\u62e9\uff01\u559c\u6b22 smart-doc \u7684\u7528\u6237\u4e5f\u4e0d\u8981\u5fd8\u8bb0\u7ed9\u9879\u76ee star\uff0c\u4f60\u4eec\u7684\u652f\u6301\u662f smart-doc \u6301\u7eed\u63a8\u8fdb\u7684\u52a8\u529b\u3002<\/p>\n

\u529f\u80fd\u7279\u6027<\/h1>\n

<\/p>\n

    \n
  • \u96f6\u6ce8\u89e3\u3001\u96f6\u5b66\u4e60\u6210\u672c\u3001\u53ea\u9700\u8981\u5199\u6807\u51c6 java \u6ce8\u91ca\u3002<\/li>\n
  • \u57fa\u4e8e\u6e90\u4ee3\u7801\u63a5\u53e3\u5b9a\u4e49\u81ea\u52a8\u63a8\u5bfc\uff0c\u5f3a\u5927\u7684\u8fd4\u56de\u7ed3\u6784\u63a8\u5bfc\u3002<\/li>\n
  • \u652f\u6301 Spring MVC,Spring Boot,Spring Boot Web Flux(controller \u4e66\u5199\u65b9\u5f0f)\u3002<\/li>\n
  • \u652f\u6301 Callable,Future,CompletableFuture \u7b49\u5f02\u6b65\u63a5\u53e3\u8fd4\u56de\u7684\u63a8\u5bfc\u3002<\/li>\n
  • \u652f\u6301 JavaBean \u4e0a\u7684 JSR303 \u53c2\u6570\u6821\u9a8c\u89c4\u8303\u3002<\/li>\n
  • \u5bf9 json \u8bf7\u6c42\u53c2\u6570\u7684\u63a5\u53e3\u80fd\u591f\u81ea\u52a8\u751f\u6210\u6a21\u62df json \u53c2\u6570\u3002<\/li>\n
  • \u5bf9\u4e00\u4e9b\u5e38\u7528\u5b57\u6bb5\u5b9a\u4e49\u80fd\u591f\u751f\u6210\u6709\u6548\u7684\u6a21\u62df\u503c\u3002<\/li>\n
  • \u652f\u6301\u751f\u6210 json \u8fd4\u56de\u503c\u793a\u4f8b\u3002<\/li>\n
  • \u652f\u6301\u4ece\u9879\u76ee\u5916\u90e8\u52a0\u8f7d\u6e90\u4ee3\u7801\u6765\u751f\u6210\u5b57\u6bb5\u6ce8\u91ca(\u5305\u62ec\u6807\u51c6\u89c4\u8303\u53d1\u5e03\u7684 jar \u5305)\u3002<\/li>\n
  • \u652f\u6301\u751f\u6210\u591a\u79cd\u683c\u5f0f\u6587\u6863\uff1aMarkdown\u3001HTML5\u3001Asciidoctor\u3001Postman json\u3002<\/li>\n
  • \u8f7b\u6613\u5b9e\u73b0\u5728 Spring Boot \u670d\u52a1\u4e0a\u5728\u7ebf\u67e5\u770b\u9759\u6001 HTML5 api \u6587\u6863\u3002<\/li>\n
  • \u5f00\u653e\u6587\u6863\u6570\u636e\uff0c\u53ef\u81ea\u7531\u5b9e\u73b0\u63a5\u5165\u6587\u6863\u7ba1\u7406\u7cfb\u7edf\u3002<\/li>\n
  • \u4e00\u6b3e\u4ee3\u7801\u6ce8\u91ca\u68c0\u6d4b\u5de5\u5177\uff0c\u4e0d\u5199\u6ce8\u91ca\u7684\u5c0f\u4f19\u4f34\u9003\u4e0d\u8fc7\u6cd5\u773c\u4e86\u3002<\/li>\n<\/ul>\n

    \u9879\u76ee\u4ed3\u5e93<\/h1>\n

    <\/p>\n

    smart-doc \u7684\u7801\u4e91\u4ed3\u5e93\u94fe\u63a5<\/p>\n

    github \u4ed3\u5e93\u5730\u5740\u94fe\u63a5<\/p>\n

    \u66f4\u65b0\u5185\u5bb9<\/h1>\n

    <\/p>\n

      \n
    1. \n

      \u54cd\u5e94\u7528\u6237\u9700\u6c42\uff0c\u5bf9 spring \u7684\u8868\u5355\u53c2\u6570\u7ed1\u5b9a\u505a\u4e86\u5168\u9762\u7684\u652f\u6301\uff0csmart-doc \u4e0d\u518d\u662f\u4ec5\u4ec5\u652f\u6301 json \u53c2\u6570\u3002<\/p>\n<\/li>\n

    2. \n

      \u5408\u5e76 fork \u5206\u652f\u7684 github book html5 \u6a21\u677f\uff0c\u65b0\u589e\u641c\u7d22\u548c\u951a\u70b9\u3002<\/p>\n<\/li>\n

    3. \n

      \u65b0\u589e\u81ea\u5b9a\u4e49 @mock tag \u7528\u4e8e\u6307\u5b9a\u751f\u6210\u6587\u6863\u65f6\u7684\u9ed8\u8ba4\u5b57\u6bb5\u503c\uff0c@param \u7684\u53c2\u6570\u6ce8\u91ca\u589e\u52a0 mock \u503c\u7684\u89e3\u6790\u529f\u80fd(@param name \u59d3\u540d|\u5f20\u4e09)\uff0c \u6b64\u9879\u6539\u8fdb\u53ef\u4ee5\u6ee1\u8db3\u7528\u6237\u76f4\u63a5\u4f7f\u7528 smart-doc \u751f\u6210\u4ea4\u4ed8\u7ed9\u7b2c\u4e09\u65b9\u516c\u53f8\u7684\u5bf9\u63a5\u6587\u6863\u3002<\/p>\n<\/li>\n

    4. \n

      smart-doc-maven-plugin \u63d2\u4ef6\u589e\u5f3a\u5bf9 maven \u6807\u51c6\u9879\u76ee\u7684\u652f\u6301(\u63d2\u4ef6\u4ecd\u7136\u5b58\u5728\u4e00\u4e9b\u95ee\u9898\uff0c\u5f53\u524d\u672a\u627e\u5230\u89e3\u51b3\u529e\u6cd5)\u3002<\/p>\n<\/li>\n

    5. \n

      \u5bf9\u751f\u6210\u7684 postman json \u6570\u636e\u505a\u4e86\u5168\u9762\u7684\u589e\u5f3a\uff0c\u65e0\u8bba\u662f json \u8fd8\u662f\u8868\u5355\u53c2\u6570\uff0c\u5bfc\u51fa\u7684 postman json \u53ef\u4ee5\u4e00\u952e\u5bfc\u5165 postman \u81ea\u52a8\u5b8c\u6210\u53c2\u6570\u5217\u8868\u56de\u586b\u3002<\/p>\n<\/li>\n

    6. \n

      \u4f18\u5316\u5bf9\u5b9e\u4f53\u7c7b\u4e2d\u679a\u4e3e\u5b57\u6bb5\u7684\u652f\u6301\u3002<\/p>\n<\/li>\n

    7. \n

      \u589e\u52a0\u5bf9\u5b9e\u4f53\u4e2d\u9759\u6001\u5e38\u91cf\u5e38\u91cf\u5b57\u6bb5\u7684\u8fc7\u6ee4\u3002<\/p>\n<\/li>\n<\/ol>\n

      \u5347\u7ea7\u5efa\u8bae<\/h1>\n

      <\/p>\n

      \u672c\u6b21\u4e3b\u8981\u662f\u5bf9\u8868\u5355\u53c2\u6570\u548c postman \u6570\u636e\u5bfc\u51fa\u505a\u4e86\u589e\u5f3a\u3002\u4e5f\u4fee\u6539\u4e86\u4e00\u8d77 bug \u548c\u90e8\u5206\u6e90\u7801\u505a\u4e86\u91cd\u6784\uff0c\u5efa\u8bae\u7528\u6237\u5347\u7ea7\u5230\u6700\u65b0\u3002<\/p>\n

      DEMO<\/h1>\n

      <\/p>\n

      \u4f7f\u7528 demo \u8f7b\u677e\u73a9\u8f6c\u63a5\u53e3\u6587\u6863\u751f\u6210<\/p>\n

      \u76f8\u5173\u6587\u6863<\/h1>\n

      <\/p>\n

      smart-doc \u6587\u6863 wiki<\/p>\n

      smart-doc \u7684\u90e8\u5206\u7528\u6237<\/h1>\n

      <\/p>\n

      \u6392\u540d\u4e0d\u5206\u5148\u540e<\/p>\n

        \n
      • \u79d1\u5927\u8baf\u98de<\/li>\n
      • \u5c0f\u7c73<\/li>\n
      • \u4e00\u52a0<\/li>\n
      • \u5317\u4eac\u8fdc\u76df\u5065\u5eb7<\/li>\n<\/ul><\/div>\n
        \u5927\u4f6c\u6709\u8a71\u8aaa<\/b> (4<\/span>) <\/div>\n
        <\/div>\n<\/p><\/div>\n<\/p><\/div>\n
          \n
        • \n
          \n
          \n
          \u8cc7\u6df1\u5927\u4f6c : codepm <\/span> <\/div>\n
          <\/i> <\/span> <\/div>\n<\/p><\/div>\n
          \u4ea7\u54c1\u300a\u9879\u76ee\u52a0\u300b\u4e5f\u6765\u652f\u6301\u4e0b\u3002 <\/div>\n<\/p><\/div>\n<\/li>\n
        • \n
          \n
          \n
          \u8cc7\u6df1\u5927\u4f6c : cydian <\/span> <\/div>\n
          <\/i> <\/span> <\/div>\n<\/p><\/div>\n
          \u989d\u3002\u4f60\u7684\u7528\u6237\u5217\u8868\uff1f\uff1f <\/div>\n<\/p><\/div>\n<\/li>\n
        • \n
          \n
          \n
          \u8cc7\u6df1\u5927\u4f6c : hccsoul <\/span> <\/div>\n
          <\/i> <\/span> <\/div>\n<\/p><\/div>\n
          \u8bc6\u522b\u4e0d\u4e86\u81ea\u5b9a\u4e49\u7684 dao\uff0c\u63d0\u793a Error \u627e\u4e0d\u5230\u7b26\u53f7 <\/div>\n<\/p><\/div>\n<\/li>\n
        • \n
          \n
          \n
          \u8cc7\u6df1\u5927\u4f6c : kylix <\/span> <\/div>\n
          <\/i> <\/span> <\/div>\n<\/p><\/div>\n
          \u6709\u673a\u4f1a\u5c31\u8bd5\u7528\u4e00\u4e0b\u770b\u770b <\/div>\n<\/p><\/div>\n<\/li>\n
        • \n","protected":false},"excerpt":{"rendered":"

          smart-doc 1.8.0 \u53d1…<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":[],"categories":[],"tags":[],"_links":{"self":[{"href":"http:\/\/4563.org\/index.php?rest_route=\/wp\/v2\/posts\/88881"}],"collection":[{"href":"http:\/\/4563.org\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"http:\/\/4563.org\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"http:\/\/4563.org\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"http:\/\/4563.org\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=88881"}],"version-history":[{"count":0,"href":"http:\/\/4563.org\/index.php?rest_route=\/wp\/v2\/posts\/88881\/revisions"}],"wp:attachment":[{"href":"http:\/\/4563.org\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=88881"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"http:\/\/4563.org\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=88881"},{"taxonomy":"post_tag","embeddable":true,"href":"http:\/\/4563.org\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=88881"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}