spring boot + swagger3 + redoc使用

最新推荐文章于 2025-03-24 15:15:58 发布
最新推荐文章于 2025-03-24 15:15:58 发布
阅读量1.6k 收藏 31
点赞数 24
文章标签： spring boot java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_44068578/article/details/138112120
版权

1.名称解释

在开始使用 Swagger 之前，我们先来了解下几个概念。

名词释义
SwaggerSwagger 是一个 RESTful 接口规范，现在流行的版本有 2.0 和 3.0 。
OpenAPIOpenAPI 规范就是之前的 Swagger 规范，只是换了个名字。
swagger.json/swagger.yamlswagger.json 或 swagger.yaml 是符合 Swagger 规范的接口描述文件。文件名称随意，这里只是举例。
SpringfoxSpringfox 套件可以为 Spring 系列项目自动生成 swagger.json，还可以集成 Swagger UI。
Swagger UISwagger UI 通过解析 swagger.[json/yaml]，来生成在线接口文档。
ReDocReDoc 是另一个 Swagger UI 工具。

2.Springfox

Springfox 当前有两个主要版本：正式版 2.9.2 和 3.0.0。下面介绍3.0.0的使用。

Maven依赖

    <properties>
        <springfox.version>3.0.0</springfox.version>
    </properties>
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-boot-starter</artifactId>
        <version>3.0.0</version>
    </dependency>

编写 Swagger 配置类

在 SpringBoot 启动类同级目录下添加该配置类。
配置类 SwaggerConfig 上添加 @Configuration 注解，是为了让 Spring 识别到这是一个配置类。


import com.doc.util.SignatureUtil;
import com.google.common.collect.Lists;
import com.google.common.collect.Sets;
import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.MediaType;
import org.springframework.web.bind.annotation.RestController;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.builders.RequestParameterBuilder;
import springfox.documentation.schema.Example;
import springfox.documentation.schema.ScalarType;
import springfox.documentation.service.*;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;

@Configuration
public class SwaggerConfig {

    @Value(value = "${swagger.enabled}")
    private boolean enabled;

    /**
     * 创建API
     */
    @Bean
    public Docket createRestApi()
    {


        return new Docket(DocumentationType.OAS_30)
                // 是否启用Swagger
                .enable(enabled)
                .produces(Sets.newHashSet(MediaType.APPLICATION_JSON_VALUE))
                .consumes(Sets.newHashSet(MediaType.APPLICATION_JSON_VALUE))
                // 用来创建该API的基本信息，展示在文档的页面中（自定义展示的信息）
                .apiInfo(apiInfo())
                // 设置哪些接口暴露给Swagger展示
                .select()
                // 扫描所有有注解的api，用这种方式更灵活
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))//方法一：不展示 Spring 自带的 error Controller
                // 扫描所有
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build()
                .useDefaultResponseMessages(false)
                .globalRequestParameters(this.getHeaderParameterList());
    }

    /**
     * 添加head参数配置
     */
    private List<RequestParameter> getHeaderParameterList() {
        RequestParameterBuilder requestParameterBuilder = new RequestParameterBuilder();
        RequestParameter app_id = requestParameterBuilder.name(SignatureUtil.appId).description("App Id").in(ParameterType.HEADER).build();

        return Lists.newArrayList(
                new RequestParameterBuilder()
                        .name("Content-Type")
                        .in(ParameterType.HEADER)
                        .query(param -> param.model(model -> model.scalarModel(ScalarType.STRING)))
                        .query(simpleParameterSpecificationBuilder -> simpleParameterSpecificationBuilder
                                .model(model -> model.scalarModel(ScalarType.STRING))
                                .defaultValue(MediaType.APPLICATION_JSON_VALUE))
                        .required(true)
                        .build()
        );
    }


    /**
     * 添加摘要信息
     */
    private ApiInfo apiInfo() {
        // logo
        ObjectVendorExtension logo = new ObjectVendorExtension("x-logo");
        logo.addProperty(new StringVendorExtension("url", "/logo_login.png"));
        logo.addProperty(new StringVendorExtension("altText", "Doc Logo"));

        // 用ApiInfoBuilder进行定制
        return new ApiInfoBuilder()
                // 设置标题
                .title("Doc API Document")
                // 描述
                .description("xxx")
                // 作者信息
                .contact(new Contact("xxx", null, null))
                // 版本
//                .version("Version:" + ruoyiConfig.getVersion())
                .termsOfServiceUrl("https://xxxx")
                .extensions(Arrays.asList(logo))
                .build();
    }

}

启用 Swagger

在 SpringBoot 的启动类上添加 @EnableSwagger2和@EnableOpenApi 注解。

Swagger 文档注解

Swagger 的文档注解有三类：

  • resource（Controller 类） 注解
  • operation（API 方法）注解
  • API models（实体类）注解

注解概览

注解描述
@Api标记一个类为 Swagger 资源。
@ApiImplicitParam表示 API Operation 中的单个参数。
@ApiImplicitParams包装注解，包含多个 @ApiImplicitParam 注解
@ApiModel提供 Swagger models 的附加信息
@ApiModelProperty添加和操作 model 属性的数据。
@ApiOperation描述一个特定路径的 operation（通常是 HTTP 方法）
@ApiParam为 operation 参数添加额外的 meta-data。
@ApiResponse描述 operation 可能的响应。
@ApiResponses包装注解，包含多个 @ApiResponse 注解。
@ResponseHeader表示响应头。

Resource API 注解

@Api

声明该 API 接口类需要生成文档。

@Api(tags = {"应用健康检查"})
@RestController
@RequestMapping(value = "/healthcheck")
public class HealthCheckController {
    ...
}
属性描述
tags属性用来对接口进行分组管理。当然你可以添加多个 tag，那么该类下的接口会在这两个分组里出现。
description接口描述

@ApiIgnore

声明该 API 接口类不需要生成文档。

@ApiIgnore("过时的API")
@ConditionalOnExpression("false")
@RestController
@RequestMapping(value = "/record/xianbank")
public class RecordXianBankController {
    ...
}

@ApiOperation

用于接口方法上，描述该接口相关信息。

@ApiOperation(
  nickname = "healthCheckUsingGet",
  value = "应用健康检查",
  notes = "用于检查应用是否可以正常访问。",
  produces = MediaType.APPLICATION_JSON_VALUE,
  response = HealthCheckRes.class
)
@GetMapping()
public BaseResult<HealthCheckRes.AppStatus> healthCheck() {
    ...
}

属性列表

属性描述
nicknameoperationID，接口唯一标识
value接口名称
notes接口描述信息
produces响应 Content-Type，示例：“application/json, application/xml”
consumes请求 Content-Type，示例：“application/json, application/xml”
responseresponse body Model，响应体结构及单个字段示例

@ApiImplicitParams 和 @ApiImplicitParam

描述接口的请求信息。

@ApiOperation(
    ...
)
//请求参数
@ApiImplicitParams({
    @ApiImplicitParam(
        name = "id",value = "用户 ID",paramType = ParamType.PATH,required = true, dataType = "Long", example = "823928392"
    )
})
@DeleteMapping("/path/{id}")
public BaseResult<SwaggerTestRes> testSwaggerWithPath(@PathVariable Long id){
  logger.info(id.toString());
  SwaggerTestRes res = new SwaggerTestRes();
  res.setId(id);
  res.setName("刘备");
  res.setAge(180);
  res.setSex('0');
  res.setAddress("蜀山大地");
  return new BaseResult(res);
}

@ApiImplicitParam 属性列表

属性类型描述
nameString参数名称。
valueString参数描述。
paramTypeString请求参数类型，String类型，枚举值包括：path、query、body、header、form。
requiredboolean是否必传，true 为必传，默认为 false。
dataTypeString参数数据类型，一般为类名。
dataTypeClassClass<?>参数数据类型，值为 Xxx.class。
exampleString参数示例，针对非 Body 类型的参数。
examplesExample参数示例，针对 Body 类型的参数。

@ApiResponses 和 @ApiResponse

描述接口的响应信息。

@ApiOperation(
    ...
)
//请求参数
@ApiImplicitParams({
    ...
})
//响应
@ApiResponses({
    //code重复的情况下，第一个声明的生效。
    @ApiResponse(code = 200,message = "成功"
        //examples 属性，springfox 2.x.x 不支持，需要 3.0.0及以上
        ,examples = @Example(
            value = {
                @ExampleProperty(mediaType = "一个示例",value = "{\n" +
                    "  \"code\": \"0000\",\n" +
                    "  \"data\": {\n" +
                    "    \"address\": \"马尔代夫\",\n" +
                    "    \"age\": 66,\n" +
                    "    \"id\": 888888,\n" +
                    "    \"name\": \"小虾米\",\n" +
                    "    \"sex\": 0\n" +
                    "  },\n" +
                    "  \"message\": \"OK\"\n" +
                    "}")}
        )
    ),
    @ApiResponse(code = 400,message = "你一定是干坏事了")
})
@DeleteMapping("/path/{id}")
public BaseResult<SwaggerTestRes> testSwaggerWithPath(@PathVariable Long id){
  logger.info(id.toString());
  SwaggerTestRes res = new SwaggerTestRes();
  res.setId(id);
  res.setName("刘备");
  res.setAge(180);
  res.setSex('0');
  res.setAddress("蜀山大地");
  return new BaseResult(res);
}
属性类型描述
codeString接口响应状态码。
messageString接口响应状态信息。
examplesExample响应示例，mediaType 为示例名称，value 为示例值。

Model 注解

@ApiModel

描述 Model（实体类）。

@ApiModel(value = "SwaggerTestRes",description = "Swagger Demo 演示实体类")
public class SwaggerTestRes {

  ...

}
属性类型描述
valueStringModel 名称，一般为实体类类名。
descriptionStringModel 描述信息。

@ApiModelProperty

描述 Model 属性。

@ApiModel(value = "SwaggerTestRes",description = "Swagger Demo 演示实体类")
public class SwaggerTestRes {

  @ApiModelProperty(value = "用户 ID",example = "23829832983")
  private Long id;
  @ApiModelProperty(value = "姓名",example = "老顽童")
  private String name;
  @ApiModelProperty(value = "年龄",example = "199",allowableValues = "range[0,200]")
  private int age;
  @ApiModelProperty(value = "性别。0：男，1：女。",example = "0",allowableValues = "0,1")
  private char sex;
  @ApiModelProperty(value = "家庭住址",example = "中国浙江省杭州市滨江区上峰电商产业园")
  private String address;

  ...

}
属性类型描述
valueString属性描述。
exampleString属性示例。
allowableValuesString限制参数值的范围。有三种限制类型。第一种，用英文逗号分隔的枚举值，如：first, second, third。第二种，固定范围，如：range[1, 5]、 range(1, 5)、range[1, 5)。第三种，接受无穷大的值范围，如：range[1, infinity]、range[-infinity, 100]

Swagger 注解完整示例

实体类


import com.doc.constant.Constants;
import com.doc.constant.HttpStatus;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;

/**
 * @author Cxx
 */
@Data
@Api("通用的返回实体")
public class R<T> {

    @ApiModelProperty(value = "code", required = true, example = "200")
    private Integer code;

    @ApiModelProperty(value = "message", required = true, example = "Success")
    private String message;

    @ApiModelProperty(value = "Return Data.", required = true)
    private T data;

    public static R ok() {
        R r = new R();
        r.setCode(HttpStatus.SUCCESS);
        r.setMessage(Constants.SUCCESS_MSG);
        return r;
    }

    public static R error() {
        R r = new R();
        r.setCode(HttpStatus.ERROR);
        r.setMessage(Constants.FAIL_MSG);
        return r;
    }

    public static R error(String message) {
        R r = new R();
        r.setMessage(message);
        return r;
    }

    public static R error(Integer code, String message) {
        R r = new R();
        r.setCode(code);
        r.setMessage(message);
        return r;
    }

    public R data(T data) {
        this.setData(data);
        return this;
    }
}


import io.swagger.annotations.ApiModelProperty;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.springframework.web.multipart.MultipartFile;

import java.io.Serializable;
import java.util.List;

@Data
@AllArgsConstructor
@NoArgsConstructor
public class CreateDoc implements Serializable {

    @ApiModelProperty(value = "Body Params", required = true)
    String data;

    @ApiModelProperty(value = "Doc File", required = true)
    List<String> file;

}

Controller 类

import com.doc.annotation.XCodeSample;
import com.doc.annotation.XCodeSamples;
import com.doc.constant.*;
import com.doc.constant.XCodesSample.EsignSample;
import com.doc.domain.R;
import com.doc.domain.vo.esign.*;
import io.swagger.annotations.*;
import org.springframework.http.MediaType;
import org.springframework.web.bind.annotation.*;

@Api(tags = "Esign Services", description = EsignSample.DESCRIPTION, protocols = "https")
@RestController
@RequestMapping("/esign")
public class EsignController {

    /**
     * 创建
     */
    @ApiOperation(value = "Create Doc", notes = EsignSample.NOTE)
    @XCodeSamples({
            @XCodeSample(lang = ProgramLangConstant.JAVA, source = EsignSample.JAVA),
            @XCodeSample(lang = ProgramLangConstant.PHP, source = EsignSample.PHP),
            @XCodeSample(lang = ProgramLangConstant.CS, source = EsignSample.CS),
            @XCodeSample(lang = ProgramLangConstant.GO, source = EsignSample.GO),
            @XCodeSample(lang = ProgramLangConstant.PYTHON, source = EsignSample.PYTHON)
    })
    @ApiResponses({
            @ApiResponse(code = HttpStatus.ERROR, message = Constants.FAIL_MSG,
                    examples = @Example({
                            @ExampleProperty(mediaType = MediaType.APPLICATION_JSON_VALUE, value = CommonSample.RESPONSE_500),
                            @ExampleProperty(mediaType = MediaType.ALL_VALUE, value = CommonSample.RESPONSE_500)
                    }))
    })
    @PostMapping("/createDoc")
    public R<CreateResDoc> createDoc(@RequestBody CreateDoc createDoc) {
        CreateResDoc createResDoc = new CreateResDoc();
        return R.ok().data(createResDoc);
    }
 }

访问 Swagger UI

  1. 启动 SpringBoot 应用。
  2. 访问 http://ip:port/swagger-ui/index.html 。ps：swgger3替换了原有的/swagger-ui.html
    在这里插入图片描述

ReDoc

获取 swagger.json 的接口

启动 SpringBoot 应用后，得到 swagger.json 的接口地址 http://ip:port/v2/api-docs。

两种方式访问在线接口文档验证：

方法一：自己写个静态 HTML 页面，放到内网服务器上。

<!DOCTYPE html>
<html>
  <head>
    <title>ReDoc</title>
    <!-- needed for adaptive design -->
    <meta charset="utf-8"/>
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet">

    <!--
    ReDoc doesn't change outer page styles
    -->
    <style>
      body {
        margin: 0;
        padding: 0;
      }
    </style>
  </head>
  <body>
    <!-- 这里填写 swagger 文件访问地址或接口访问地址 -->
    <redoc spec-url='https://doc.xxx.cn/swagger/mocklab' untrustedSpec=true></redoc>
    <script src="https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js"> </script>
  </body>
</html>

方法二：使用官方的在线交互 Demo，把自己的接口地址 http://ip:port/v2/api-docs 填进去。
在这里插入图片描述

文档效果

在这里插入图片描述

衍生知识：redoc中添加不同代码的示例Code

1.新增配置代码和自定义注解


import com.google.common.collect.Lists;
import org.springframework.stereotype.Component;
import springfox.documentation.service.ListVendorExtension;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spi.service.OperationBuilderPlugin;
import springfox.documentation.spi.service.contexts.OperationContext;
import com.doc.annotation.XCodeSamples;
import com.doc.annotation.XCodeSample;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Optional;

/**
 * Swagger Extensions Add
 *
 * @author Cxx
 */
@Component
public class SwaggerXCodesBuilderPlugin implements OperationBuilderPlugin {
    @Override
    public void apply(OperationContext context) {
        List<Object> list = new ArrayList<>();

        Optional<XCodeSamples> samples = context.findAnnotation(XCodeSamples.class);
        if (samples.isPresent()) {
            XCodeSample[] value = samples.get().value();
            for (XCodeSample xCodeSample : value) {
                list.add(new HashMap(){{
                    put("lang", xCodeSample.lang());
                    put("source", xCodeSample.source());
                }});
            }
        }

        context.operationBuilder().extensions(Lists.newArrayList(
                new ListVendorExtension("x-codeSamples", list)
        ));
    }

    @Override
    public boolean supports(DocumentationType delimiter) {
        return true;
    }
}


package com.doc.annotation;

import java.lang.annotation.*;

/**
 * Swagger样例代码注解
 *
 * @author Cxx
 */

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface XCodeSample {

    /**
     * 语言
     */
    String lang() default "";

    /**
     * 代码
     */
    String source() default "";
}


package com.doc.annotation;

import java.lang.annotation.*;

/**
 * Swagger样例代码注解(父)
 *
 * @author Cxx
 */

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface XCodeSamples {

    XCodeSample[] value();
}

2.使用方式

    @ApiOperation(value = "Create Doc", notes = EsignSample.NOTE)
    @XCodeSamples({
            @XCodeSample(lang = ProgramLangConstant.JAVA, source = EsignSample.JAVA),
            @XCodeSample(lang = ProgramLangConstant.PHP, source = EsignSample.PHP),
            @XCodeSample(lang = ProgramLangConstant.CS, source = EsignSample.CS),
            @XCodeSample(lang = ProgramLangConstant.GO, source = EsignSample.GO),
            @XCodeSample(lang = ProgramLangConstant.PYTHON, source = EsignSample.PYTHON)
    })
    @ApiResponses({
            @ApiResponse(code = HttpStatus.ERROR, message = Constants.FAIL_MSG,
                    examples = @Example({
                            @ExampleProperty(mediaType = MediaType.APPLICATION_JSON_VALUE, value = CommonSample.RESPONSE_500),
                            @ExampleProperty(mediaType = MediaType.ALL_VALUE, value = CommonSample.RESPONSE_500)
                    }))
    })
    @PostMapping("/createDoc")
    public R<CreateResDoc> createDoc(@RequestBody CreateDoc createDoc) {
        CreateResDoc createResDoc = new CreateResDoc();
        return R.ok().data(createResDoc);
    }

public class EsignSample {
    /**
     * JAVA
     */
    public static final String JAVA = "OkHttpClient client = new OkHttpClient().newBuilder()\n" +
            "  .build();\n" +
            "MediaType mediaType = MediaType.parse(\"application/json\");\n" +
            "RequestBody body = RequestBody.create(mediaType, \"\");\n" +
            "Request request = new Request.Builder()\n" +
            "  .url(\"https://XXXX/\")\n" +
            "  .method(\"POST\", body)\n" +
            "  .addHeader(\"appId\", \"255c79e81b48b0ffed2fd61e6a3229ff\")\n" +
            "  .addHeader(\"Content-Type\", \"application/json\")\n" +
            "  .build();\n" +
            "Response response = client.newCall(request).execute();";
}
鱼二锅头
关注
redoc-demo:ReDoc API文档平台演示
03-18
还原演示 ReDoc API文档平台演示
oas3-redoc-spring-boot-starter:集成OAS3（OpenAPI3）和ReDoc的Spring Boot Starter，一个开箱即用的Spring MVC文档库
03-20
oas3-redoc-spring-boot-starter 本Starter集成和 ，为Spring Boot MVC应用提供开箱即用的文档集成。 如果本项目对你有帮助，欢迎给我加星关注〜 运行示例API gradlew :example-api:bootRun 文档地址： 重做： ...
Redoc 使用教程
gitblog_00141的博客
08-09 776
Redoc 使用教程 redoc???? OpenAPI/Swagger-generated API Reference Documentation项目地址:https://gitcode.com/gh_mirrors/re/redoc Redoc 是一个用于从 OpenAPI 定义自动生成美观 API 文档的开源工具。本教程将指导您了解 Redoc 的项目结构、启动文件以及配置文件。 1. 项目目...
SpringBoot3整合Swagger
最新发布
weixin_41863745的博客
03-24 835
之前一直使用SpringBoot2与Swagger2，所以感觉都很顺利，因网上资源也比较多问题不大。但是自从更新idea2024、jdk17之后，很多依赖都是比较新的版本，之前的很多东西需要去适应新版本就会出现很多bug，网上的很多办法不好用，只好在改好bug之后记录一下，以便大家一起学习。提示Springdoc-OpenAPI 使用教程-CSDN博客。
使用redoc来生成文档
funnyPython的博客
07-02 6725
redoc只需要一个.yaml就可以生成一个很漂亮的文档。 https://github.com/Redocly/redoc 这是一个写接口文档的神器，里面的格式可以参照openapi3.0来写。 根据https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md 知道它的结构了可以点目录速查 比如你现在写了一个openapi.yaml的文档 安装 redoc-cli npm i -g redoc-cli 执行如下
redoc 项目使用教程
gitblog_00008的博客
10-10 1050
redoc 项目使用教程 项目地址:https://gitcode.com/gh_mirrors/redo/redoc 1. 项目介绍 redoc 是一个用于实现 R Markdown 和 Microsoft Word 之间双向转换的 R 包。它能够生成可以反向转换回 R Markdown 的 Word 文档，保留 Word 文档中的编辑内容，包括跟踪的更改。redoc 目前处于暂停状态，但其核心...
使用Spring Boot与Swagger生成API文档
[使用Spring Boot与Swagger生成API文档](https://img-blog.csdnimg.cn/0d40b20bdd2345b69c39a930c63c7271.png) # 1. Spring Boot与Swagger简介** Swagger是一个流行的开源框架，用于生成RESTful API文档。它与...
Spring Boot文档库集成：OAS3和ReDoc的简便解决方案
总结以上知识点，可以了解到oas3-redoc-spring-boot-starter是一个专注于简化Spring Boot项目中API文档生成流程的工具，它通过集成OpenAPI 3规范和ReDoc文档生成器，为开发者提供了一个开箱即用的API文档解决方案。...
Back-end-Spring-Boot:原始REST
04-18
使用Swagger或ReDoc等工具，可以自动化生成REST API的文档，方便开发者和客户端使用。 总的来说，Spring Boot结合RESTful设计，为开发者提供了构建高效后端服务的强大支持。通过理解上述关键概念和技术，您可以...
自动配置和Spring MVC来创建一个RESTful Web服务.rar
06-04
6. **文档化API**: 使用Swagger或ReDoc等工具，可以方便地生成RESTful API的文档，帮助开发者和使用者更好地理解API的使用方法。 7. **部署与运行**: Spring Boot应用可以被打包为独立的JAR或WAR文件，支持运行在...
redoc：redoc-从多个项目存储库生成文档
02-04
重做 redoc是一个应用程序，可用于显示来自多个Github存储库的样式化Markdown 。 redoc从GitHub获取内容并 ，缓存HTML以通过目录进行管理，并以主题包进行样式化。 git clone https://github.com/reactioncommerce/redoc.git cd redoc && npm install meteor --settings settings.json 要运行测试： npm run test -运行单元测试npm run test-app “完整应用”测试npm run chimp运行浏览器测试（在应用运行时） npm run
swagger:Swagger和ReDoc助手
04-30
Be.Vlaanderen.Basisregisters.AspNetCore.Swagger Swagger和ReDoc助手。 目标 提供一种简单的方法来配置项目以使用Swagger，并提供了很好的API文档。 快速贡献指南 在本地进行分叉和克隆。 使用Visual Studio， build.cmd或build.sh构建解决方案。 在git中创建主题特定的分支。 在代码中添加一个不错的功能。 不要忘记添加测试和/或文档。 运行build.cmd或build.sh以确保所有内容仍可编译且所有测试仍通过。 生成后，您将在./dist找到二进制文件，然后可以在本地进行测试，以确保错误或功能已成功修复/实现。 发送拉取请求。 快速开始 参考和或两者。 看一下示例项目。 浏览到您的API的根目录。 昂首阔步 特征 阅读汇编中的Swagger请求和响应示例。 将枚举描述为字符串。
aiohttp-swagger3:使用swagger规范3.0进行swagger文档浏览和验证aiohttp请求的库
05-03
aiohttp-swagger3 关于 用于通过不同的UI后端显示swagger文档以及使用swagger规范3.0（称为OpenAPI3）可选地验证/解析aiohttp请求的软件包。 支持的UI后端 如果仅需要验证而无法查看文档，则可以使用多个UI后端，或者可以完全禁用UI后端。 Swagger UI- ReDoc- RapiDoc- 文献资料 https://aiohttp-swagger3.readthedocs.io/en/latest/ 禁用验证 将validate=False传递给SwaggerDocs / SwaggerFile类，默认值为True 另外，有时必须禁用路由验证，为此，您必须在路由初始化期间传递validate=False 。 前任。 web.post("/route", handler, validate=False) ，默认值为True 要
spring-boot中文API文档
01-23
spring-boot中文API文档。（spring-boot-中文参考手册.pdf）
redoc-tryout:ReDoc的试用功能
05-10
还原尝试 这是为Redoc提供试用功能的权宜之计解决方案： : 此实现使用JQuery，它位于ReDoc旁边，等待其完全加载，然后将按钮与单击侦听器绑定。 进行了单独的Ajax调用，以仅为Try-out功能加载swagger.json。 单击“ Try-Out按钮时，将在swagger.json之后生成一个表单。 演示： ： 怎么跑 克隆项目。 在浏览器中打开demo.html。 “ Try-Out按钮应显示在右侧面板上每个方法的下方。 单击“ Try-Out以Try-Out表格。 单击Send以发出http请求。 请注意，由于这是Bowser Ajax调用，因此将redoc部署在单独的主机中时，您的api应该以正确的CORS标头响应。 如何配置 全局变量var defaultHost ：默认情况下，http将进入swagger.json中的.host属性。 如果swagger
编写api常用工具swagger和redoc
xxiangaa的博客
06-19 1379
常用编写api框架
了解ReDoc
lmz_lmz的博客
07-20 7568
REDOC - OPENAPI-POWERED DOCUMENTATION UI   伊万·贡查罗夫     我们都喜欢SwaggerUI。这是Swagger / OpenAPI如此受欢迎的原因之一。最近API文档世界出现了一些新的趋势。其中之一是三面板设计文档。竞争的API规范格式有它们，例如API Blueprint有aglio，Postman有Postman Document...
SpringBoot集成Swagger3.0
weixin_45817985的博客
03-06 1728
SpringBoot集成Swagger3.0
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值