io.jboot.component.swagger.JbootSwaggerController Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of jboot Show documentation

Jboot is a similar SpringCloud project base on JFinal, Dubbo and Undertow.

There is a newer version: 4.1.9

/**
 * Copyright (c) 2015-2018, Michael Yang 杨福海 ([email protected]).
 * 
 * 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.
 */
package io.jboot.component.swagger;

import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.serializer.SerializeConfig;
import com.google.common.collect.Maps;
import io.jboot.Jboot;
import io.jboot.web.controller.JbootController;
import io.jboot.web.cors.EnableCORS;
import io.swagger.models.Swagger;
import io.swagger.models.properties.RefProperty;

/**
 * @author Michael Yang 杨福海 （[email protected]）
 * @version V1.0
 * @Package io.jboot.component.swagger
 */
public class JbootSwaggerController extends JbootController {

    JbootSwaggerConfig config = Jboot.config(JbootSwaggerConfig.class);

    public void index() {
        String html = null;
        String viewPath = config.getPath().endsWith("/") ? config.getPath() : config.getPath() + "/";
        try {
            html = renderToString(viewPath + "index.html", Maps.newHashMap());
        } catch (Throwable ex) {
        }

        if (html == null) {
            renderHtml("error，please put  swagger-ui into your project path :  " + config.getPath() + " 
" +
                    "or click here  show swagger json.");
            return;
        }

        html = html.replace("http://petstore.swagger.io/v2/swagger.json", getRequest().getRequestURL() + "/json");
        html = html.replace("src=\"./", "src=\"" + config.getPath() + "/");
        html = html.replace("href=\"./", "href=\"" + config.getPath() + "/");

        renderHtml(html);
    }

    /**
     * 渲染json
     * 参考：http://petstore.swagger.io/ 及json信息 http://petstore.swagger.io/v2/swagger.json
     */
    @EnableCORS
    public void json() {
        Swagger swagger = JbootSwaggerManager.me().getSwagger();
        if (swagger == null) {
            renderText("swagger config error.");
            return;
        }

        // 适配swaggerUI, 解决页面"Unknown Type : ref"问题。
        SerializeConfig serializeConfig = new SerializeConfig();
        serializeConfig.put(RefProperty.class, new RefPropertySerializer());
        renderJson(JSON.toJSONString(swagger, serializeConfig));
    }

}