我有基于Jersey 1.18.1的RESTful服务,我希望通过Swagger显示我的API。
首先我必须得到JSON。我读了这条指令:Swagger Core Jersey 1.X Project Setup 1.5。 Swagger允许设置不同的配置方法,我决定使用自定义的Application子类。我一步一步地做了所有事情,但我无法获得JSON,我必须使用swagger-ui。
我做了什么:
我的自定义应用程序
@ApplicationPath("api/v1")
public class DiscountsApp extends Application{
public DiscountsApp() {
BeanConfig beanConfig = new BeanConfig();
beanConfig.setVersion("1.0.2");
beanConfig.setSchemes(new String[]{"http"});
beanConfig.setHost("localhost:8002");
beanConfig.setBasePath("swaggerapi");
beanConfig.setResourcePackage("alexiuscrow.diploma.endpoints");
beanConfig.setScan(true);
}
@Override
public Set<Class<?>> getClasses() {
Set<Class<?>> resources = new HashSet();
resources.add(ShopsResources.class);
//...
resources.add(com.wordnik.swagger.jaxrs.listing.ApiListingResource.class);
resources.add(com.wordnik.swagger.jaxrs.listing.SwaggerSerializers.class);
return resources;
}
}
ShopsResources
@Path("/shops")
@Api(value="/shops", description="Shops")
public class ShopsResources {
@GET
@Produces(MediaType.APPLICATION_JSON)
@ApiOperation(value = "List shops", httpMethod = "GET",
notes = "List nearest or locality shops",
response = Shops.class, responseContainer = "List")
public String getShops(
@ApiParam( value = "Radius", required = false)
@QueryParam("radius") String radiusParam,
@ApiParam( value = "Latitude", required = true)
@QueryParam("lat") String latParam,
@ApiParam( value = "Longitude", required = true)
@QueryParam("lng") String lngParam) throws SQLException{
//The list of Shops objects is serialized to string
//using the custom GSON serializer and I know
//that there is the better method of the solution of this task.
}
}
}
来自pom.xml的一些依赖项
<dependency>
<groupId>javax.ws.rs</groupId>
<artifactId>jsr311-api</artifactId>
<version>1.1.1</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>com.sun.jersey</groupId>
<artifactId>jersey-server</artifactId>
<version>1.18.1</version>
</dependency>
<dependency>
<groupId>com.sun.jersey</groupId>
<artifactId>jersey-servlet</artifactId>
<version>1.18.1</version>
</dependency>
<dependency>
<groupId>com.sun.jersey</groupId>
<artifactId>jersey-bundle</artifactId>
<version>1.18.1</version>
</dependency>
<dependency>
<groupId>com.wordnik</groupId>
<artifactId>swagger-jersey-jaxrs</artifactId>
<version>1.5.1-M2</version>
</dependency>
在向Tomcat部署应用程序后,我试图获得http://localhost:8002/swaggerapi,但我没有得到任何结果。
我在应用程序的根目录中找不到swagger.json
(/tomcat8/webapps/app
)。
出了什么问题?
如何使用我的API获取JSON?
答案 0 :(得分:3)
我没有正确构建网址。
正确:
http:// {host}:{port} / {申请的上下文根} / {@ApplicationPath
的路径} / swagger.json
就我而言:http://localhost:8080/app/api/v1/swagger.json
Thx to Ron。
答案 1 :(得分:-1)
添加一个适合我的相对路径(这是使用.netcore 1.1)
app.UseSwaggerUI(s => {
s.RoutePrefix = "help";
s.SwaggerEndpoint("../swagger/v1/swagger.json", "MySite");
s.InjectStylesheet("../css/swagger.min.css");
});