1

Rest API を文書化するために、swagger を使用しようとしています。私は Tomcat/Spring サーバーを開発しており、残りの API は Jersey を使用して開発されています。

私はswaggerガイドに従い、必要なデータをweb.xmlに追加しました:

<servlet>
        <servlet-name>resources</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.wordnik.swagger.jersey.listing;app.servlet.resources.jersey;org.codehaus.jackson.jaxrs</param-value>
        </init-param>
       <init-param>
        <param-name>swagger.api.basepath</param-name>
        <param-value>http://localhost:8080/main/resources/</param-value>
        </init-param>
        <init-param>
            <param-name>api.version</param-name>
            <param-value>1</param-value>
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>

http://:8080/main/resources/api-docs は次を返します。

{"apiVersion":"0.0","swaggerVersion":"1.2"}

ここで何が欠けているのか分かりますか?

4

1 に答える 1

3

以下を「web.xml」に追加してみてください (適切なservlet-class場所を定義していることを確認してください)。

<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>

「Bootstrap」、「ApiOriginFilter」、「ApiListingResource」、および「ApiListingResourceJSON」（ApiListing を拡張）があることを確認してください。これらのファイルの次の例を参照してください。

ブートストラップ:

/**
 * Copyright 2012 Wordnik, Inc.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this
 * file except in compliance with the License. You may obtain a copy of the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software distributed under
 * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */

import com.wordnik.swagger.jaxrs.JaxrsApiReader;

import javax.servlet.http.HttpServlet;

public class Bootstrap extends HttpServlet{

    private static final long serialVersionUID = 1L;

    static{
        JaxrsApiReader.setFormatString("");
    }
}

ApiOriginFilter:

import java.io.IOException;

import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.http.HttpServletResponse;

public class ApiOriginFilter implements javax.servlet.Filter{
    @Override
    public void doFilter(ServletRequest request, ServletResponse response,
            FilterChain chain) throws IOException, ServletException{
        HttpServletResponse res = (HttpServletResponse) response;
        res.addHeader("Access-Control-Allow-Origin", "*");
        res.addHeader("Access-Control-Allow-Methods", "GET, POST, DELETE, PUT");
        res.addHeader("Access-Control-Allow-Headers", "Content-Type");
        chain.doFilter(request, response);
    }

    @Override
    public void destroy(){
    }

    @Override
    public void init(FilterConfig filterConfig) throws ServletException{
    }
}

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{
}

ApiListingResourceJSON:

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

import com.wordnik.swagger.annotations.Api;
import com.wordnik.swagger.jaxrs.listing.ApiListing;

@Path("/api-docs")
@Api("/api-docs")
@Produces({ "application/json"})
public class ApiListingResourceJSON extends ApiListing{
}

これでいいはずです... Swagger は非常に優れており、一度セットアップすれば「問題なく動作」しますが、セットアップするにはまだ体操をする必要があります。

HTH。

于 2013-10-08T06:56:14.383 に答える