标签：导入到 swagger yapi url value import springfox id

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

yapi安装参考
window10 yapi安装 swagger配置 及 Error: getaddrinfo ENOTFOUND yapi.demo.qunar.com解决
https://www.cnblogs.com/oktokeep/p/16504113.html

pom引入swagger jar
compile("io.springfox:springfox-swagger2:2.8.0")
compile("io.springfox:springfox-swagger-ui:2.8.0")

创建配置类

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();
    }
}

接口配置 @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来导入。

标签：导入到,swagger,yapi,url,value,import,springfox,id
来源： https://www.cnblogs.com/oktokeep/p/16517002.html

本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享；
2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关；
3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关；
4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除；
5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。