swagger core 和 swagger ui 如何关联【窥探】

几个片段:

package io.swagger.jaxrs.listing;

import io.swagger.annotations.ApiOperation;
import org.apache.commons.lang3.StringUtils;

import javax.servlet.ServletConfig;
import javax.servlet.ServletContext;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.core.*;

@Path("/swagger.{type:json|yaml}")
public class ApiListingResource extends BaseApiListingResource {

    @Context
    ServletContext context;

    @GET
    @Produces({MediaType.APPLICATION_JSON, "application/yaml"})
    @ApiOperation(value = "The swagger definition in either JSON or YAML", hidden = true)
    public Response getListing(
            @Context Application app,
            @Context ServletConfig sc,
            @Context HttpHeaders headers,
            @Context UriInfo uriInfo,
            @PathParam("type") String type) {
        if (StringUtils.isNotBlank(type) && type.trim().equalsIgnoreCase("yaml")) {
            return getListingYamlResponse(app, context, sc, headers, uriInfo);
        } else {
            return getListingJsonResponse(app, context, sc, headers, uriInfo);
        }
    }

}

package io.swagger.jaxrs.listing;

import io.swagger.models.Swagger;
import io.swagger.util.Json;
import io.swagger.util.Yaml;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.MultivaluedMap;
import javax.ws.rs.ext.MessageBodyWriter;
import javax.ws.rs.ext.Provider;
import java.io.IOException;
import java.io.OutputStream;
import java.lang.annotation.Annotation;
import java.lang.reflect.Type;

@Provider
@Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, "application/yaml"})
public class SwaggerSerializers implements MessageBodyWriter<Swagger> {
    static boolean prettyPrint = false;
    Logger LOGGER = LoggerFactory.getLogger(SwaggerSerializers.class);

    public static void setPrettyPrint(boolean shouldPrettyPrint) {
        SwaggerSerializers.prettyPrint = shouldPrettyPrint;
    }

    @Override
    public boolean isWriteable(Class type, Type genericType, Annotation[] annotations,
                               MediaType mediaType) {
        return Swagger.class.isAssignableFrom(type);
    }

    @Override
    public long getSize(Swagger data, Class type, Type genericType, Annotation[] annotations, MediaType mediaType) {
        return -1;
    }

    @Override
    public void writeTo(Swagger data,
                        Class<?> type,
                        Type genericType,
                        Annotation[] annotations,
                        MediaType mediaType,
                        MultivaluedMap<String, Object> headers,
                        OutputStream out) throws IOException {
        if (mediaType.isCompatible(MediaType.APPLICATION_JSON_TYPE)) {
            if (prettyPrint) {
                out.write(Json.pretty().writeValueAsString(data).getBytes("utf-8"));
            } else {
                out.write(Json.mapper().writeValueAsString(data).getBytes("utf-8"));
            }
        } else if (mediaType.toString().startsWith("application/yaml")) {
            headers.remove("Content-Type");
            headers.add("Content-Type", "application/yaml");
            out.write(Yaml.mapper().writeValueAsString(data).getBytes("utf-8"));
        } else if (mediaType.isCompatible(MediaType.APPLICATION_XML_TYPE)) {
            headers.remove("Content-Type");
            headers.add("Content-Type", "application/json");
            out.write(Json.mapper().writeValueAsString(data).getBytes("utf-8"));
        }
    }
}
  <!-- this scans the classes for resources -->
  <bean id="swaggerConfig" class="io.swagger.jaxrs.config.BeanConfig">
    <property name="resourcePackage" value="io.swagger.sample.resource"/>
    <property name="version" value="1.0.0"/>
    <property name="host" value="localhost:8080/swagger-java-cxf-sample"/>
    <property name="basePath" value="/api"/>
    <property name="title" value="Swagger Petstore"/>
    <property name="description" value="This is a app."/>
    <property name="contact" value="[email protected]"/>
    <property name="license" value="Apache 2.0"/>
    <property name="licenseUrl" value="http://www.apache.org/licenses/LICENSE-2.0.html"/>
    <!-- <property name="filterClass" value="ApiAuthorizationFilterImpl"/> -->
    <property name="scan" value="true"/>
  </bean>

basePath 是定位到项目的前提下,访问谁

      var url = window.location.search.match(/url=([^&]+)/);
      if (url && url.length > 1) {
        url = decodeURIComponent(url[1]);
      } else {
        url = "http://localhost:8080/swagger-java-cxf-sample/api/swagger.json";
      }

访问谁,访问哪个路径

!IMPORTANT

这个是基于jax-rs 项目整合的

时间: 2024-10-05 10:04:02

swagger core 和 swagger ui 如何关联【窥探】的相关文章

swagger.core的使用方法

Swagger 是一个规范和完整的框架,用于生成.描述.调用和可视化 RESTful 风格的 Web 服务,那么如何在abp中使用呢,已经有大牛为我们实现了一个swagger.core的组件而作为菜鸟的我们只需要通过简单安装配置即可使用. 1.安装 通过“程序管理包控制台进行安装,键入Install-Package Swashbuckle.Core命令即可,注意:这里的默认项目一定要是webapi这一层” 2.配置 引入名称空间 using Swashbuckle.Application; us

.NET Core使用swagger进行API接口文档管理

一.问题背景 随着技术的发展,现在的开发模式已经更多的转向了前后端分离的模式,在前后端开发的过程中,联系的方式也变成了API接口,但是目前项目中对于API的管理很多时候还是通过手工编写文档,每次的需求变更只要涉及到接口的变更,文档都需要进行额外的维护,如果有哪个小伙伴忘记维护,很多时候就会造成一连续的问题,那如何可以更方便的解决API的沟通问题?Swagger给我们提供了一个方式,由于目前主要我是投入在.NET Core项目的开发中,所以以.NET Core作为示例 二.什么是Swagger S

ASP.NET CORE API Swagger+IdentityServer4授权验证

简介 本来不想写这篇博文,但在网上找到的文章博客都没有完整配置信息,所以这里记录下. 不了解IdentityServer4的可以看看我之前写的入门博文 Swagger 官方演示地址 源码地址 配置IdentityServer4服务端 首先创建一个新的ASP.NET Core项目. 这里选择空白项,新建空白项目 等待创建完成后,右键单击项目中的依赖项选择管理NuGet程序包,搜索IdentityServer4并安装: 等待安装完成后,下载官方提供的UI文件,并拖放到项目中.下载地址:https:/

Asp.Net Core webApi Swagger 配置说明

概要在官网上很容 可以找到开启Swagger Gen 的配置信息,这也是我们快速开发 Api 的开始使得我们不用写API 的文档和测试了 .理想很丰满,但在使用时我们 部分Get 接口可以用了但是我们Post 时候需要我们做 身份验证了,Token 是不错的选择.这也是.我学习Swagger ,不精的问题.怎么开启身份认证?. 进入正题 我把我用到的所有代码黏贴出来:一个个的说: Swagger 注册: services.AddSwaggerGen(c => { c.OperationFilte

【dotNet Core】Swagger下简单的给WebApi分组

Startup.cs下ConfigureServices代码 这里主要在DocInclusionPredicate控制输出那些api. Startup.cs下Configure代码 给Controllers或Action添加[ApiExplorerSettings(GroupName= "ApiGroupName")] ApiGroupAttribute 若不想使用Microsoft.AspNetCore.Mvc下的ApiExplorerSettingsAttribute,可以自己建一

.NET CORE API Swagger

新建一个core api  项目,使用nuget搜索Swashbuckle.AspNetCore   安装 修改项目生成属性 修改启动Startup public void ConfigureServices(IServiceCollection services) { services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_1); #region Swagger services.AddSwaggerGe

.Net Core 添加 Swagger 支持

1. NuGet  中添加 Swashbuckle.AspNetCore 2.添加 Startup 信息 将 Swagger 生成器添加到 Startup.ConfigureServices 方法中的服务集合中: //注册Swagger生成器,定义一个和多个Swagger 文档 services.AddSwaggerGen(c => { c.SwaggerDoc("v1", new Info { Title = "My API", Version = &quo

.net core 使用swagger生成API文档

[1]安装Swashbuckle.AspNetCore包 [2]在Startup.cs中注册swagger //注册Swagger生成器,定义一个和多个Swagger 文档 services.AddSwaggerGen(c => { c.SwaggerDoc("v1", new Info { Title = "爱住微订API", Version = "v1" }); }); [3]在Startup.cs中配置swagger app.UseS

.Net Core 使用 Swagger 提供API文档

1.运行环境 开发工具:Visual Studio 2017 JDK版本:.NET Core 2.0 项目管理工具:nuget 2.GITHUB地址 https://github.com/nbfujx/NetCore-learn-demo/tree/master/netCore_swagger