使用swagger或任何其他工具生成Rest API文档

Question

我正在寻找一种方法来记录我的Rest API.我的服务器是Tomcat/Spring服务器,Rest API是使用Jenkins实现的.

Swagger似乎是一个非常酷的解决方案,但我无法弄清楚我如何使用它与我的代码.我正在寻找创建json swagger的最好方法 - ui可以阅读 - 我该怎么做？

此外,我很乐意检查在此类环境中记录Rest API的任何其他好的解决方案.

Answer 1

我没有试过招摇,但你可以试着发声.它可以生成JAX-RS端点的文档,作为javadoc阶段的一部分.有关生成的文档的一些示例可在enunciate页面上找到

更新

项目已移至http://enunciate.webcohesion.com/,即将推出的版本2.0将支持java 8.

Answer 2

要启用swagger-ui,您可以"按原样"使用它 - 来自文档:

"你可以使用swagger-ui代码AS-IS!不需要构建或重新编译 - 只需克隆这个repo并使用dist文件夹中的预构建文件.如果你喜欢swagger-ui,请停在这里. "

因此,基本上您只需要在Web服务器中放置"dist"内容,然后在UI中输入Web服务的swagger端点,例如:( http://localhost:8080/Webservice/api-doc.json这是您必须在Web中定义的相同地址端点. XML).

我怀疑你有一些错误配置的其他细节,这很容易,因为有几个地方你必须配置Swagger.在下文中,我将向您介绍我在Swagger中设置的一些细节.

这是我的web.xml上Swagger配置的片段:

<!-- // Jersey declaration -->
<servlet>
    <servlet-name>web service</servlet-name>
    <servlet-class>com.sun.jersey.spi.container.servlet.ServletContainer</servlet-class>
    <init-param>
        <param-name>com.sun.jersey.config.property.packages</param-name>
        <param-value>com.mywebservice;com.wordnik.swagger.jaxrs.listing;com.fasterxml.jackson.jaxrs</param-value>
    </init-param>
    <init-param>
        <param-name>com.sun.jersey.config.property.classnames</param-name>
        <param-value>com.mywebservice;com.wordnik.swagger.jaxrs.listing;com.fasterxml.jackson.jaxrs</param-value>
    </init-param>
    <init-param>
        <param-name>swagger.api.basepath</param-name>
        <param-value>http://localhost:8080/Webservice</param-value>
    </init-param>
    <init-param>
        <param-name>api.version</param-name>
        <param-value>0.0.2</param-value>
    </init-param>
    <load-on-startup>1</load-on-startup>
</servlet>
<servlet>
    <servlet-name>Bootstrap</servlet-name>
    <servlet-class>com.mywebservice.utils.swagger.Bootstrap</servlet-class>
    <load-on-startup>1</load-on-startup>
</servlet>
<filter>
    <filter-name>ApiOriginFilter</filter-name>
    <filter-class>com.mywebservice.utils.swagger.ApiOriginFilter</filter-class>
</filter>
<filter-mapping>
    <filter-name>ApiOriginFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

Bellow是com.mywebservice.utils.swagger包的列表,其中有Swagger文档中提供的几种资源(现在看起来与我设置时不同,所以这里是完整的文档列表):

您可以在Swagger的示例项目中找到这些文件(或示例):https://github.com/wordnik/swagger-core/tree/master/samples/java-jaxrs,您应该尝试将其用作"模板" "设置你的招摇.我遇到麻烦的一个文件是ApiListingResource:

import javax.ws.rs.Path;
import javax.ws.rs.Produces;

import com.wordnik.swagger.annotations.Api;
import com.wordnik.swagger.jaxrs.JavaApiListing;

@Path("/resources.json")
@Api("/resources")
@Produces({ "application/json"})
public class ApiListingResource extends JavaApiListing{
}

HTH.