<?xml version="1.0" encoding="UTF-8"?>
<rss version="2.0">
  <channel>
    <title>run27017 (Run)</title>
    <link>https://ruby-china.org/run27017</link>
    <description/>
    <language>en-us</language>
    <item>
      <title>做了一个 swagger 的 API 文档云端撰写工具</title>
      <description>&lt;p&gt;不知道大家会不会用 swagger 生成 Restful 的 API 文档，反正我是写了一个云端的 Swagger 撰写工具，它支持：&lt;/p&gt;

&lt;ol&gt;
&lt;li&gt;API 的私有性，对项目组外不可见&lt;/li&gt;
&lt;li&gt;支持多人编写同一个文档的自动合并和冲突报警&lt;/li&gt;
&lt;li&gt;编写超过一万行的文档不卡顿&lt;/li&gt;
&lt;/ol&gt;

&lt;p&gt;&lt;strong&gt;本行放工具链接： &lt;a href="https://run27017.tk/swaggerhuge" rel="nofollow" target="_blank" title=""&gt;SwaggerHuge&lt;/a&gt;&lt;/strong&gt;&lt;/p&gt;

&lt;p&gt;另外，我认为，撰写文档主要有三种方式：&lt;/p&gt;

&lt;ol&gt;
&lt;li&gt;使用内嵌注释或者 DSL，然后工具生成&lt;/li&gt;
&lt;li&gt;使用在线的文档撰写工具，如 swaggerhub&lt;/li&gt;
&lt;li&gt;使用可视化的文档在线工具，如阿里的 RAP&lt;/li&gt;
&lt;/ol&gt;

&lt;p&gt;就我个人来说，我的倾向顺序是 1,2,3. 有些人可能觉得可视化的东西很好，我并不是很习惯。&lt;/p&gt;

&lt;p&gt;最后，希望大家多提点意见，热切欢迎各种交流。我的邮箱是 run27017@126.com&lt;/p&gt;</description>
      <author>run27017</author>
      <pubDate>Thu, 26 Apr 2018 15:12:36 +0800</pubDate>
      <link>https://ruby-china.org/topics/36068</link>
      <guid>https://ruby-china.org/topics/36068</guid>
    </item>
  </channel>
</rss>
