对于常用的场景，例如幂等、分页、异步API的设计有没有统一的规范，避免使用体验不一致？ 错误码应该怎么设计？公共错误码怎么统一，业务错误码怎么表达？...比如网上汇款，从账户1向账户2汇款500元，错误的 URL 是： POST /accounts/1/transfer/500/to/2 正确的写法是把动词 transfer 改成transaction，...当服务器无法识别请求的方法，并且无法支持其对任何资源的请求。 502 Bad Gateway 作为网关或者代理工作的服务器尝试执行请求时，从上游服务器接收到无效的响应。...504 Gateway Timeout 作为网关或者代理工作的服务器尝试执行请求时，未能及时从上游服务器（URI标识出的服务器，例如HTTP、FTP、LDAP）或者辅助服务器（例如DNS）收到响应。...七、错误处理（Error Handling） 如果出错，应该在 response body 中通过 message 给出明确的错误信息（一般来说，返回的信息中将 message 作为键名，出错详情作为键值即可
估计大部分程序员在处理这样的问题时，都会采用这样的解决问题的路径。它直白，不易出错。...我接手后做的处理是，定义一个简单的 feed parsing language，把我们希望从各个 feed 获取的数据的最终形态定义出来，然后每一个域声明如何从 feed 里取出这个域的值的类似 xpath...要能够通过它来生成代码，第一步我们需要将其正确解析，处理好各种各样的情况，也就是说，我们要为其写一个 parser。而要撰写这样一个 parser，我们首先需要读懂 OpenAPI spec。...Quenya 的 OpenAPI parser Quenya 对 OpenAPI 的主要 object 做了一一映射，在 parser 加载 open API yaml 文件时，会解析整个文档，并生成对应的数据结构...然而，在运行时，你的 API 项目并不需要对 OpenAPI spec 做任何解析。所以，尽管项目中引入了 Quenya parser，它依旧是编译时的工作。
一款零注解侵入的 API 文档生成工具 介绍 smart-doc是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具，smart-doc在业内率先提出基于JAVA...泛型定义推导的理念，完全基于接口源码来分析生成接口文档，不采用任何注解侵入到业务代码中。...支持导出错误码和定义在代码中的各种字典码到接口文档。 支持Maven、Gradle插件式轻松集成。 支持Apache Dubbo RPC接口文档生成。...Smart-doc 从 2.0.0 后几乎实现了 swagger ui 的功能，并且比 swagger ui 更简洁大方，也更符合国内开发者的诉求。...当然 smart-doc 本身是只支持扫描代码生成 openapi 3.0 的文档的，也可以将生成的 openapi 3.0 文档导入到其他ui中渲染展示。 ---- 效果示例 1.
对JSON请求参数的接口能够自动生成模拟JSON参数。 对一些常用字段定义能够生成有效的模拟值。 支持生成JSON返回值示例。 支持从项目外部加载源代码来生成字段注释(包括标准规范发布的jar包)。...支持导出错误码和定义在代码中的各种字典码到接口文档。 支持Maven、Gradle插件式轻松集成。 支持Apache Dubbo RPC接口文档生成。...": "code",//错误码的code码字段名称 "descField": "message"//错误码的描述信息对应的字段名 }], "revisionLogs": [{ //文档变更记录...后期遇到同名字段则直接给相应字段加注释，非必须 "name": "code",//覆盖响应码字段 "desc": "响应代码",//覆盖响应码的字段注释 "ownerClassName...替换Pageable做文档渲染 }], "apiConstants": [{//从1.8.9开始配置自己的常量类，smart-doc在解析到常量时自动替换为具体的值 "constantsClassName
介绍 smart-doc是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具，smart-doc在业内率先提出基于JAVA泛型定义推导的理念，完全基于接口源码来分析生成接口文档...对JSON请求参数的接口能够自动生成模拟JSON参数。 对一些常用字段定义能够生成有效的模拟值。 支持生成JSON返回值示例。 支持从项目外部加载源代码来生成字段注释(包括标准规范发布的jar包)。...支持导出错误码和定义在代码中的各种字典码到接口文档。 支持Maven、Gradle插件式轻松集成。 支持Apache Dubbo RPC接口文档生成。...Smart-doc 从 2.0.0 后几乎实现了 swagger ui 的功能，并且比 swagger ui 更简洁大方，也更符合国内开发者的诉求。...当然 smart-doc 本身是只支持扫描代码生成 openapi 3.0 的文档的，也可以将生成的 openapi 3.0 文档导入到其他ui中渲染展示。
1介绍 smart-doc是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具，smart-doc在业内率先提出基于JAVA泛型定义推导的理念，完全基于接口源码来分析生成接口文档...对JSON请求参数的接口能够自动生成模拟JSON参数。 对一些常用字段定义能够生成有效的模拟值。 支持生成JSON返回值示例。 支持从项目外部加载源代码来生成字段注释(包括标准规范发布的jar包)。...支持导出错误码和定义在代码中的各种字典码到接口文档。 支持Maven、Gradle插件式轻松集成。 支持Apache Dubbo RPC接口文档生成。...Smart-doc 从 2.0.0 后几乎实现了 swagger ui 的功能，并且比 swagger ui 更简洁大方，也更符合国内开发者的诉求。欢迎关注我们，公号终码一生。...当然 smart-doc 本身是只支持扫描代码生成 openapi 3.0 的文档的，也可以将生成的 openapi 3.0 文档导入到其他ui中渲染展示。
主要介绍小鹅通在 TSE 云原生 API 网关上的一些建设和经验，以及在这个过程中遇到了哪些问题和挑战，基于 TSE 的解决方案又是如何在小鹅通进行落地的，以及如何利用云原生网关实现降本增效的经验分享。...第四阶段：通过 OpenAPI 全量同步100多个公网负载、上千条的路由规则，在这个过程中，梳理了大量的路由规则，确认涉及的功能以及影响范围，将不确定性的部分变为确定性。...如何完成平稳流量切割 关于如何完成域名平稳流量切割到 TSE 云原生 API 网关，这里列举了两个简化的场景。...第一种场景，设置域名解析权重，请求解析到不同的后端实例完成分流，从1%逐步增加流量直到全量请求到 TSE 云原生 API 网关，再将域名解析切换到 TSE 云原生 API 网关。...2、充分利用 OpenAPI、CRD、插件的方式提高小鹅通的自动化能力，将一些动作和小鹅通的服务初始化的流程和其他环节打通，提高效率的同时也降低了出错的可能性。
支持导出错误码和定义在代码中的各种字典码到接口文档。 支持Maven、Gradle插件式轻松集成。 支持Apache Dubbo RPC接口文档生成。...无需启动项目，生成文档后可直接浏览 缺点 我总结了一下我使用过程中的缺点，在此我仅代表我自己提出的缺点如下 生成的openapi.json数据时，不支持泛型的多层嵌套解析，导致不同接口的responseBody...当然 smart-doc 本身是只支持扫描代码生成 openapi 3.0 的文档的，也可以将生成的 openapi 3.0 文档导入到其他 ui 中渲染展示。...由于他们设计思路 理念 不一样，swagger2 使用过程需要使用它定义的@API 相关注解，这样就污染了源码，代码入侵有点高，而smart -doc 就不一样了，主要是通过 注释 、解析/** */...ApiDocProperties自定义配置，开发人员只关心自己当前服务的smart-doc相关配置即可 DocController工具包中的uri进行资源访问，可以自定义html，openapi.json
限流、权限、熔断、协议转换、错误码统一、缓存、日志、监控、告警等，这样将通用的逻辑抽出来，由网关统一去做，业务方也能够更专注于业务逻辑，提升迭代的效率。...API注册 业务方如何接入网关?一般来说有几种方式。...比如通过Swagger\OpenAPI等，比如阿里云的网关: ?...稳定性 稳定性是网关非常重要的一环，监控、告警需要做的很完善才可以，比如接口调用量、响应时间、异常、错误码、成功率等相关的监控告警，还有线程池相关的一些，比如活跃线程数、队列积压等，还有些系统层面的，比如...网关管控平台 这块也是非常重要的一环，需要考虑好整个流程的用户体验，比如接入到网关的这个流程，能不能尽量简化、智能，比如如果是dubbo接口，我们可以通过到git仓库中获取源码、解析对应的类、方法，从而实现自动填充
熔断、协议转换、错误码统一、缓存、日志、监控、告警等，这样将通用的逻辑抽出来，由网关统一去做，业务方也能够更专注于业务逻辑，提升迭代的效率。...API注册 业务方如何接入网关?一般来说有几种方式。...比如通过Swagger\OpenAPI等，比如阿里云的网关: ?...稳定性 稳定性是网关非常重要的一环，监控、告警需要做的很完善才可以，比如接口调用量、响应时间、异常、错误码、成功率等相关的监控告警，还有线程池相关的一些，比如活跃线程数、队列积压等，还有些系统层面的，比如...网关管控平台 这块也是非常重要的一环，需要考虑好整个流程的用户体验，比如接入到网关的这个流程，能不能尽量简化、智能，比如如果是dubbo接口，我们可以通过到git仓库中获取源码、解析对应的类、方法，从而实现自动填充
，问题会很难定位 错误码统一 缓存 日志 监控 告警 接入 第一种采用插件扫描业务方的API,比如spring mvc的注解, 并结合swagger的注解, 从而实现参数校验, 文档&&SDK生成等功能...配置文件导入, 比如通过swagger\openAPI等, 比如阿里云的网关 服务发现 网关作为流量的入口, 负责请求的转发, 但首先需要知道转发给谁, 如何寻址 写死在代码或配置文件中 域名 注册中心...稳定性 稳定性是网关非常重要的一环，监控、告警需要做的很完善才可以，比如接口调用量、响应时间、异常、错误码、成功率等相关的监控告警，还有线程池相关的一些，比如活跃线程数、队列积压等，还有些系统层面的，比如...网关管控平台 这块也是非常重要的一环，需要考虑好整个流程的用户体验，比如接入到网关的这个流程，能不能尽量简化、智能，比如如果是dubbo接口，我们可以通过到git仓库中获取源码、解析对应的类、方法，从而实现自动填充...，尽量帮用户减少操作；另外接口一般是从测试->预发->线上，如果每次都要填写一遍表单会非常麻烦，我们能不能自动把这个事情做掉，另外如果网关部署到了多个可用区、甚至不同的国家，那这个时候，我们还需要接口数据同步功能
---- Introduce smart-doc是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具，smart-doc在业内率先提出基于JAVA泛型定义推导的理念...对JSON请求参数的接口能够自动生成模拟JSON参数。 对一些常用字段定义能够生成有效的模拟值。 支持生成JSON返回值示例。 支持从项目外部加载源代码来生成字段注释(包括标准规范发布的jar包)。...支持生成多种格式文档：Markdown、HTML5、Asciidoctor、Postman Collection、OpenAPI 3.0。...轻易实现在Spring Boot服务上在线查看静态HTML5 api文档。 开放文档数据，可自由实现接入文档管理系统。 支持导出错误码和定义在代码中的各种字典码到接口文档。...请求参数示例 响应参数示例效果图 ? 响应参数示例 html文档效果图 ? 开源地址：https://gitee.com/smart-doc-team/smart-doc
在微服务架构中，有一个组件可以说是必不可少的，那就是微服务网关，微服务网关处理了负载均衡，缓存，路由，访问控制，服务代理，监控，日志等。API网关在微服务架构中正是以微服务网关的身份存在。...三、企业中在如何应用API网关 1、对于OpenAPI使用的API网关来说，一般合作伙伴要以应用的形式接入到OpenAPI平台，合作伙伴需要到 OpenAPI平台申请应用。...1、性能与可用性 如果一旦采用了API网关，那么API网关就会作为企业应用核心，因此性能和可用性是必须要求的。 从性能上来说，需要让网关增加的时间消耗越短越好，个人觉得需要10ms以下。...系统需要采用非阻塞的IO，如epoll，NIO等。网关和各种依赖的交互也需要是非阻塞的，这样才能保证整体系统的高可用性，如：Node.js的响应式编程和基于java体现的RxJava和Future。...综合上面的分析，基础公有云的API网关只有满足一部分简单客户的需求，对于很多企业来说私有云的API网关才是正确的选择。 祝大家在2020年工作顺路，家庭幸福，合家团圆
Introduce smart-doc是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具，smart-doc在业内率先提出基于JAVA泛型定义推导的理念， 完全基于接口源码来分析生成接口文档...，不采用任何注解侵入到业务代码中。...对JSON请求参数的接口能够自动生成模拟JSON参数。 对一些常用字段定义能够生成有效的模拟值。 支持生成JSON返回值示例。 支持从项目外部加载源代码来生成字段注释(包括标准规范发布的jar包)。...轻易实现在Spring Boot服务上在线查看静态HTML5 api文档。 开放文档数据，可自由实现接入文档管理系统。 支持导出错误码和定义在代码中的各种字典码到接口文档。...请求参数示例 响应参数示例效果图 ? 响应参数示例 html文档效果图 ?
当然写接口文档不是搞文学创作，为了直接从写好的代码中自动提取信息来生成文档，就必须要有一套标准的文档格式，否则工具无法知道要从代码中提取出哪些信息，信息提取之后，也不知道该如何组织这些信息。...完善文档 drf-yasg 毕竟不是使用人工智能开发的，即使是使用人工智能，也很难做到 100% 的正确，毕竟由人类写的代码可能是千变万化的，工具无法预料到所有可能的情况，一旦它遇到无法处理的地方，自动生成的文档就可能出错...GET /posts/{id}/comments/ 这个接口应该还支持分页查询的参数，但生成的文档中没有列出，接口响应参数也是错误的，正确的应该是一个分页后的评论列表，但文档中是单个评论对象。...其中 toc 和 body_html 因为不是 Post 中定义的字段，所以 drf-yasg 无法知道关于这两个字段的说明。 drf-yasg 是如何知道这个接口会返回哪些响应参数的呢？...原理是 drf-yasg 会尝试去解析接口对应的序列化器（Serializer），从序列化器中提取出对应的请求和响应字段（如果序列化器中找不到，它会进一步去序列化器关联的模型中找），因此我们就可以给序列化器中定义的字段添加说明信息
在微服务架构中，有一个组件可以说是必不可少的，那就是微服务网关，微服务网关处理了负载均衡，缓存，路由，访问控制，服务代理，监控，日志等。API网关在微服务架构中正是以微服务网关的身份存在。...三、企业中在如何应用API网关 1、 对于OpenAPI使用的API网关来说，一般合作伙伴要以应用的形式接入到OpenAPI平台，合作伙伴需要到 OpenAPI平台申请应用。...从性能上来说，需要让网关增加的时间消耗越短越好，个人觉得需要10ms以下。系统需要采用非阻塞的IO，如epoll，NIO等。...网关和各种依赖的交互也需要是非阻塞的，这样才能保证整体系统的高可用性，如：Node.js的响应式编程和基于java体现的RxJava和Future。...综合上面的分析，基础公有云的API网关只有满足一部分简单客户的需求，对于很多企业来说私有云的API网关才是正确的选择。
在微服务架构中，有一个组件可以说是必不可少的，那就是微服务网关，微服务网关处理了负载均衡，缓存，路由，访问控制，服务代理，监控，日志等。API网关在微服务架构中正是以微服务网关的身份存在。...企业如何应用 API 网关 1、对于OpenAPI使用的API网关来说，一般合作伙伴要以应用的形式接入到OpenAPI平台，合作伙伴需要到 OpenAPI平台申请应用。...1、性能与可用性 如果一旦采用了API网关，那么API网关就会作为企业应用核心，因此性能和可用性是必须要求的。 从性能上来说，需要让网关增加的时间消耗越短越好，个人觉得需要10ms以下。...系统需要采用非阻塞的IO，如epoll，NIO等。网关和各种依赖的交互也需要是非阻塞的，这样才能保证整体系统的高可用性，如：Node.js的响应式编程和基于java体现的RxJava和Future。...综合上面的分析，基础公有云的API网关只有满足一部分简单客户的需求，对于很多企业来说私有云的API网关才是正确的选择。 ?
领取专属 10元无门槛券
手把手带您无忧上云
云服务器
即时通信 IM
ICP备案
对象存储
实时音视频
