微服务引入swagger生成接口的json导入到yapi配置方法 数据管理 开启url导入

微服务引入swagger生成接口的json导入到yapi配置方法 数据管理 开启url导入

​

yapi安装参考

window10 yapi安装 swagger配置 及 Error: getaddrinfo ENOTFOUND yapi.demo.qunar.com解决

https://cloud.tencent.com/developer/article/2455650

pom引入swagger jar

代码语言：txt复制

compile("io.springfox:springfox-swagger2:2.8.0")

代码语言：txt复制

compile("io.springfox:springfox-swagger-ui:2.8.0")

创建配置类

代码语言：javascript复制

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@EnableSwagger2
@Configuration
public class Swagger2Config {

    @Bean
    public Docket createRestApi() {
        //返回文档摘要信息，配置项目的主目录
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.main.dir"))
                .paths(PathSelectors.any())
                .build();
    }
    /**
     * 项目信息
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("ProjectService RESTful APIs")
                .version("1.0")
                .build();
    }
}

代码语言：javascript复制

接口配置 @ApiOperation
    @RequestMapping(value = "/updateById", method = RequestMethod.POST)
    @ApiOperation(value = "修改单条信息")
    public ResponseVo<String> updateById(@Validated @RequestBody InfoUpdateReqVo reqVo) throws MyException {
        //
    }

model配置 @ApiModel    @ApiModelProperty
    @ApiModel(value = "InfoUpdateReqVo", description = "修改单条信息入参")
    public class InfoUpdateReqVo extends BaseRequest {
    @ApiModelProperty(value="id,不作展示，查看或编辑使用",required = true)
    

接口配置 @ApiOperation
    @ApiOperation(value = "根据id查询信息")
    @GetMapping("/getInfoById/{id}")
    public ResponseVo<InfoDetailResVo> getInsuranceById(@ApiParam(name = "id",value = "列表返回主键id",required = true) @PathVariable("id") Integer id)throws Exception {
        //
    }

model配置 @ApiModel    @ApiModelProperty    
    @ApiModel(value = "InfoDetailResVo",description = "查询信息返回结果")
    public class InfoDetailResVo {
    @ApiModelProperty(value="id,不作展示，查看或编辑使用")
    private Integer id;

通过http://ip:port/swagger-ui.html进行查看，同时可以输入接口参数，手动执行简单的测试；

进入yapi的数据管理页面，通过swagger方式，输入swagger的json文件对应的url：http://{ip}:{port}/{project Name}/v2/api-docs 执行数据导入操作，如：http://127.0.0.1:8080/renren-fast/v2/api-docs

如果该项目存在{project Name}访问路径的情况下。

启动项目，访问如下地址：

http://局域网IP:端口号/swagger-ui.html#/

http://局域网IP:端口号/v2/api-docs

尽量不要使用localhost，如果yapi部署和服务在本机是可以的，如果是在不同的局域网机器，需要通过局域网IP来导入。

数据管理 开启url导入

微服务 swagger 接口 配置 数据管理

0 人点赞