生成RESTAPI文档

有没有办法自动生成我的Jersey Rest服务的a风格文档？这是迄今为止我看过的最好的REST文档之一。我对其他选择持开放态度

看起来也很有希望，但我不知道如何生成它。似乎它需要一个YAML风格的文档

我可以从javadoc生成它吗

---

我更喜欢通过Maven生成文档。

向基于jersey的服务添加swagger并不太复杂。 有关如何进行的详细信息，请参见以下内容：

---

希望对您有所帮助

您可以通过使用从Javadoc生成swagger ui，它有一个swagger模块。首先，您需要将maven插件添加到pom文件中；e、 g

<plugin>
        <groupId>com.webcohesion.enunciate</groupId>
        <artifactId>enunciate-maven-plugin</artifactId>
        <version>${enunciate.version}</version>
        <executions>
           <execution>
                  <goals>
                    <goal>docs</goal>
                  </goals>
                  <configuration>
                    <configFile>enunciate.xml</configFile>
                    <docsDir>${project.build.directory}</docsDir>
                  </configuration>
           </execution>
        </executions>
</plugin>

其中“Enounciate.xml”包含项目特定的配置，如下所示：

<enunciate xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:noNamespaceSchemaLocation="http://enunciate.webcohesion.com/schemas/enunciate-2.0.0-M.3.xsd">

    <application root="/rest" />

</enunciate>

然后运行mvn包，它将从您的Javadoc生成Swagger文档文件

p、 你可以用它来记录你的RESTAPI，设置起来并不困难。这里有一些说明。总结如下：

添加招摇过市依赖项 将以下依赖项添加到pom.xml中：

昂首阔步 类根据您的需要更改值：

@应用程序路径/api 公共类MyApplication扩展了应用程序{ 公共MyApplication{ BeanConfig BeanConfig=新BeanConfig； beanConfig.setVersion1.0； beanConfig.setSchemesnew字符串[]{http}； beanConfig.setHostlocalhost:8080； beanConfig.setBasePath/api； beanConfig.setResourcePackageio.swagger.resources，com.example.project； beanConfig.setScantrue； } } 构建项目，启动服务器并访问http://localhost:8080/app/api/swagger.json URL在您的环境中可能会有所不同，以获取记录API的JSON

设置招摇过市用户界面 从下载Swagger UI，并将内容从dist文件夹复制到web内容文件夹。我通常创建一个名为api docs的文件夹来存储所有Swagger UI文件

打开Swagger UI的index.html并更改指向Swagger.json的URL：

var swaggerUi=新的swaggerUi{ 网址：http://localhost:8080/app/api/swagger.json, dom_id:swagger用户界面容器 }; 通路http://localhost:8080/app/api-文档URL在您的环境中可能不同。带有API文档的招摇过市UI应该在那里

更多信息 你总是能满足你的需要

Swagger读取以生成文档。此外，您可以使用来改进它