使用OAS Validator帮助你规范OpenAPI Spec文档

AI编程范式演进:从Vibe Coding到Spec Coding 编程范式正经历从直觉驱动的Vibe Coding向规范驱动的Spec Coding转变。传统开发模式依赖开发者经验,存在认知过载和知识传承难题;而现代AI编程通过结构化规范定义,实现需求精准传递和代码自动生成。这种转变在GitHub调研中显示92%开发者已采用,能提升60%开发效率并降低技术债务。核心在于建立业务层、技术层、实现层的完整规范体系,结合OpenAPI等工具实现需求工程化。企业落地时需渐进迁移,通过质量门禁确保AI生成代码符合架构约束和安全要求。开发者需升级能力模型,掌握规范定义、Prompt工 阅读详情

当前主流的开发RESTful API的做法有两种:Code First和Contract First。Code First指先写代码,然后生成Contract,而Contract First则是先写Contract再写代码实现。

两种做法各有利弊,Code First可以让开发人员先写接口实现,然后利用工具反向生成Contract,优点是快速开发,并能保证接口实现与Contract保证一致,缺点是Contract太过易变容易导致下游应用故障。Contract First则可以让Contract的变动受控,保证下游应用的稳定性,缺点是需要人工来保证接口实现与Contact的一致性,具有一定难度。

对于如何规范管理Contract,新开普软件研究院开源的OAS Validator[1]提供了一些思路,下面简单介绍。

OAS Validator支持对使用OpenAPI V3[2]编写的Contract文档做合规性校验(也可称之为风格校验)。

在一个微服务架构的系统中,提供RESTful API的组件可能会有很多个,并且由不同开发人员/团队开发,那么在使用这些接口的时候有一个很自然的需求就是希望这些接口(或接口文档)的风格是一致的。OAS Validator的合规性校验做的就是这部分工作。下面举例说明怎么使用合规性校验功能:

  1. 下载代码: https://github.com/NewCapec-Institute/oas-validator clone

  2. 然后 mvn clean install打包

  3. 到oas-validator-web/target目录下执行java -jar oas-validator-web-exec.jar启动OAS Validator Web

  4. 访问 http://localhost:8080,进入合规性校验功能

  5. 把 petstore.yaml (https://github.com/OAI/OpenAPI-Specification/blob/master/examples/v3.0/petstore.yaml)内容贴到文本框中然后点击校验得到结果:

$.tags : 至少提供一个	
$.openapi : 必须>=3.0.2	
$.components.schemas.'Pet'.title : 必须提供	
$.components.schemas.'Pet'.properties.'id'.title : 必须提供	
$.components.schemas.'Pet'.properties.'name'.title : 必须提供	
$.components.schemas.'Pet'.properties.'tag'.title : 必须提供	
$.components.schemas.'Error'.title : 必须提供	
$.components.schemas.'Error'.properties.'code'.title : 必须提供	
$.components.schemas.'Error'.properties.'message'.title : 必须提供	
$.info.description : 必须提供	
$.paths./pets.get.tags[0] : 不在$.tags所定义的范围内	
$.paths./pets.get.responses.200.headers.'x-next' : 必须为upper hyphen case	
$.paths./pets.post.tags[0] : 不在$.tags所定义的范围内	
$.paths./pets/{petId}.get.tags[0] : 不在$.tags所定义的范围内

下面是功能截图:

640?wx_fmt=png

下面举例解释检查报告的意思:

$.components.schemas.'Pet'.title : 必须提供,前面一段是JsonPath[3],用来描述出问题的元素/属性的位置,“必须提供”则的意思是没有填写该属性。如下图:

640?wx_fmt=png

title是一个文档性字段,没有它虽然不影响接口的语义,但是对于下游应用的开发者来说没有它会造成理解上的困难,因此在这里我们把它设定为必填。

再来看这一条报告 $.paths./pets.get.responses.200.headers.'x-next' : 必须为upper hyphen case,同样前面是JsonPath,告诉你该属性应该为Upper Hyphen Case,正确的写法应该是X-Next。和title属性一样Header的大小写不是一个技术问题,但是统一的大小写风格能够让下游应用的开发人员更舒适,从而有更少的Bug。

不管你是采用Code First还是Contract First,Contract的变动不可避免,那么如何保证变化后的Contract能够对下游应用向下兼容就成了不可回避的问题。这个问题的具体描述就是根据V1.0 Contract开发的下游应用是否依然能够与根据V1.1 Contract实现的接口正确交互。

OAS Validator提供了这种兼容性校验,当然同样只支持OpenAPI V3文档。下面举例说明如何使用这一功能:

我们先提供一个v1.0的OAS Spec:

openapi: "3.0.0"	
info:	
  version: 1.0	
  title: Swagger Petstore	
paths:	
  /pets/{petId}:	
    get:	
      operationId: showPetById	
      tags:	
        - pets	
      parameters:	
        - name: petId	
          in: path	
          required: true	
          schema:	
            type: string	
      responses:	
        '200':	
          description: Expected response to a valid request	
          content:	
            application/json:	
              schema:	
                $ref: "#/components/schemas/Pet"	
components:	
  schemas:	
    Pet:	
      type: object	
      required:	
        - id	
        - name	
      properties:	
        id:	
          type: integer	
          format: int64	
        name:	
          type: string

再写一个v1.1的OAS Spec,添加了一个query参数name:

openapi: "3.0.0"	
info:	
  version: 1.1	
  title: Swagger Petstore	
paths:	
  /pets/{petId}:	
    get:	
      operationId: showPetById	
      tags:	
        - pets	
      parameters:	
        - name: petId	
          in: path	
          required: true	
          schema:	
            type: string	
        - name: name	
          in: query	
          required: true	
          schema:	
            type: string	
      responses:	
        '200':	
          description: Expected response to a valid request	
          content:	
            application/json:	
              schema:	
                $ref: "#/components/schemas/Pet"	
components:	
  schemas:	
    Pet:	
      type: object	
      required:	
        - id	
        - name	
      properties:	
        id:	
          type: integer	
          format: int64	
        name:	
          type: string

然后同样打开OAS Validator Web,进入“兼容性校验”功能,在左侧贴上v1.0在右侧贴上v1.1,点击校验得到结果:

$.paths./pets/{petId}.get.parameters[1].required : [name=name,in=query]:仅允许新增required=false的parameter

这个报告的意思是新增的query参数name是必填的,这种做法不向下兼容。仔细想想是不是的确如此?

关于OAS Validator的详细文档可见Github。需要注意的是,目前校验规则还不能配置,但是在代码层面提供了接口供扩展,你可以根据自己的需求写一个自己的合规性校验器。

目前OAS Validator已捐赠给Servicecomb Toolkit[4],同时已整合到Servicecomb Toolkit项目中提供服务,希望能够为广大开发者带来帮助。

最后,欢迎开发者朋友们加入ServiceComb社区,一起做些有意思的事情。加入社区方法[5]

如果文章对您有帮助,欢迎小伙伴收藏toolkit项目,为项目加Star~

https://github.com/apache/servicecomb-toolkit

[1] OAS Validator https://github.com/NewCapec-Institute/oas-validator

[2] OpenAPI V3 https://github.com/OAI/OpenAPI-Specification

[3]JsonPath https://github.com/json-path/JsonPath

[4] Servicecomb Toolkit https://github.com/apache/servicecomb-toolkit

[5]加入Servicecomb社区http://servicecomb.incubator.apache.org/cn/docs/join_the_community/

小伙伴们,2019最受欢迎中国开源软件评选开始啦!

请帮忙给

【开发框架、库类】的Apache ServiceComb

640?wx_fmt=png

以及  

Go Chassis

640?wx_fmt=png

投票啦!

【投票方式】

1、识别二维码直接投票

640?wx_fmt=png

2、点文末阅读原文进入页面投票

(每人可以投5票)

组织需要你的一臂之力

请给予我们支持和反馈

我们会继续努力

为大家提供更好用的开源软件服务

爱你们!

Swagger API契约体系:数据科学家的生产级文档实践 API文档是连接模型与生产环境的核心契约,其本质是定义接口的类型约束、行为规范与演化规则。OpenAPI规范通过严格的schema描述实现请求/响应结构化,配合Pydantic模型自动校验与Tornado异步服务深度集成,可构建可执行、可验证、可追溯的API治理体系。该体系显著提升前后端协作效率、增强错误可观测性,并支撑灰度发布与多版本兼容等MLOps关键场景。本文聚焦Swagger在真实工业项目中的工程落地,涵盖OAS设计、模型自动生成、Tornado集成及生产避坑,助力数据科学家跨越从Notebook到 阅读详情

相关推荐

Ubuntu系统下主板GPU温控pwm风扇

在Linux系统下——以Ubuntu为例,配置主板sys_fan等接口连接pwm温控风扇转速根据NVIDIA GPU温度,为服务器GPU等无主动散热显卡提供散热。

罗思哲的博客 5040

什么是 OpenAPI,OpenAPI 规范基本信息

OpenAPI 是规范化描述 API 领域应用最广泛的行业标准,由定义并维护,同时也是 Linux 基金会下的一个开源项目。通常我们所说的 OpenAPI 全称应该是 OpenAPI Specification(OpenAPI 规范,简称 OSA),它使用规定的格式来描述 HTTP RESTful API 的定义,以此来规范 RESTful 服务开发过程。使用 JSON 或 YAML 来描述一个标准的、与编程语言无关的 HTTP API 接口。

api_Anzexi的博客 1万+

Coze知识库搭建:智能化管理与高效检索实践

知识管理系统是现代企业信息资产管理的核心基础设施,其核心原理是通过结构化存储和智能检索技术实现知识的快速流转。在技术实现上,基于NLP的语义理解引擎和知识图谱构建是关键,能够显著提升检索准确率和知识关联性。以Coze平台为例,其针对中文场景优化的分词算法和多模态处理能力,可有效解决技术文档管理中的术语识别和格式兼容问题。这类系统在开发团队知识沉淀、新员工培训等场景中价值显著,特别是当集成RBAC权限模型和自动化备份策略后,既能保障信息安全,又能实现持续的知识迭代。通过合理配置同义词扩展和权重调整,可使搜索命

weixin_29041195的博客 262

如何使用 go-openapi/spec3:深入指南

如何使用 go-openapi/spec3:深入指南 项目概述 go-openapi/spec3 是一个用于处理 OpenAPI 规范(也称为 Swagger)第三版本的强大Go语言库。它旨在帮助开发者生成、解析和操作OpenAPI定义文件,从而简化RESTful API的设计与实现过程。这个项目对于那些想要基于OpenAPI规范创建或理解其描述文件的人来说至关重要。 1. 项目目录结构及介绍 g...

gitblog_00493的博客 1064

Dzzoffice结合OnlyOffice 报错排查流程总结

首先访问 OnlyOffice 首页,如下图:出现上图仍旧不能说明你的 OnlyOffice 服务已经成功安装,我们需要启动 OnlyOffice 服务测试用例来检测,可以看到上图出现了两条命令,第一条命令是用来启动测试用例服务的,我们只需要在后台执行该命令即可,Windows环境是以管理员身份运行Windows PowerShell输入即可运行了。

小胡的博客 4601

【BAAS】基于supabase的知识库详细设计

为满足快速开发需要和减少开发及维护成本,使用BAAS(Backend-as-a-Service)模式可以很好的降低我们的后端维护成本,并提高前端对接效率。一般来说,BAAS是一种云服务模式,BaaS供应商会为提供一些通用的能力,例如用户身份验证、数据库管理、远程更新和推送通知(针对移动应用程序),以及云存储和自托管。BaaS最主流的是Google的firebase,具有相当完善的功能和集成方案,但他是收费的,而且在我们实际项目中,可能需要私有化部署,这时就需要一些开源的替代方案,例如主流的。

Ric的博客 1781

openapi-spec-validator:验证OpenAPI规范的强大工具

openapi-spec-validator:验证OpenAPI规范的强大工具 项目介绍 在当今的软件开发领域,API 已经成为系统间互操作的核心。OpenAPI 规范(之前称为 Swagger)定义了一种标准,以描述 RESTful API 的接口。它使得 API 设计者可以更容易地创建、维护和文档化他们的 API。然而,确保 API 规范完全遵循 OpenAPI 标准并非易事。为此,opena...

gitblog_00659的博客 1423

Halcon那些事:Halcon缺陷检测检测印刷数字完整性

创建模板 create_shape_model模板匹配 find_shape_model。

十多年IT经验,专注机器视觉,智能制造半导体行业 771

OAuth2授权

目录1. OAuth2解决什么问题2. OAuth2简介2.1 OAuth2的四个重要角色3. 部署OAuth2需要完成的工作3.1 作为Resource server3.1 作为Client4. OAuth2的授权流程5. OAuth2的4种授权模式6. OAuth2刷新令牌7. Token的传递方式8. 总结 & 参考 1. OAuth2解决什么问题 情景: 小妹在QQ空间积攒了多年...

Apollo 576

【unity游戏开发入门到精通——UGUI】UI控件 —— Image图像控件

【unity游戏开发入门到精通——UGUI】UI控件 —— Image图像控件

向宇的博客,专注php/web全栈 unity游戏开发,欢迎大家评论纠错 2362

打破RK3588 GPIO中断响应延迟的枷锁,开启高效编程

本文针对RK3588芯片在智能安防和工业自动化应用中出现的GPIO中断响应延迟问题展开深入分析。通过硬件原理剖析,发现延迟主要源于中断控制器优先级设置、线路干扰等硬件因素,以及中断处理函数复杂、内核调度延迟等软件问题。提出硬件优化方案包括合理布局布线、电源稳定设计,软件层面则通过精准配置设备树、精简中断处理函数、利用工作队列等内核机制进行优化。测试结果显示,优化后中断响应延迟从50-80ms降至10-20ms,高负载下也能稳定在50ms以内。文章最后展望了AI技术在中断调度中的潜在应用价值。

远程部署调试 运行安装 项目调试 二次开发 项目技术新 持续迭代 部分源码免费分享 364

探索OpenAPI Specification:构建可互操作的RESTful API的利器

是一个开放源代码项目,由OpenAPI Initiative (OAI)维护,它提供了一种标准化的方法来描述你的Web服务接口,使得开发者能够理解、生成和交互于RESTful API。本文将深入探讨该项目的技术核心、应用场景以及显著特点。 ## 项目简介 OpenAPI规范(也被称为Swagger)是一个JSON或YAML格式的文件,用于定义HTTP服务,包括资源及其操作,请求和响应的结构,认...

gitblog_00069的博客 932

YOLOv5源码逐行超详细注释与解读(5)——配置文件yolov5s.yaml

全网最详细的YOLOv5源码解读之配置文件yaml。逐行注释,逐句讲解,一文带你了解yaml。小白必看!

路人贾的博客 1万+

如何集成OAS-Kit到CI/CD流水线:自动化API验证与转换

在现代API开发中,保持API规范的一致性和质量至关重要。OAS-Kit作为一款强大的OpenAPI工具套件,能够帮助您自动化Swagger到OpenAPI的转换、验证和代码检查流程。本文将为您详细介绍如何将OAS-Kit无缝集成到CI/CD流水线中,实现API规范的自动化验证与转换。🚀 ## 为什么需要自动化API规范验证? 在持续集成和持续部署的环境中,API规范的质量直接影响着整个系统

gitblog_00730的博客 377

廖雪峰Python教程[完整版]

廖雪峰的python教程整理的,已经排好版了,而且还是完整的,适合小白

jdk-8u144-linux-x64.tar.gz.

该资源为搭建Linux系统Java环境用,资源的后缀为tar.gz格式的压缩包

Tornado+Pydantic构建可维护API文档的实战指南

API文档是连接数据科学与工程落地的核心契约,其本质是机器可读的接口元数据规范。基于OpenAPI Specification(OAS)标准,文档需准确反映请求结构、响应格式、错误码及校验逻辑,从而支撑前端校验、自动化测试与SDK生成。Pydantic模型作为Schema唯一真相源,通过Field描述、example示例和validator约束,将类型定义升维为业务语义;Tornado虽无原生OpenAPI支持,但手动构造Spec可深度掌控paths、components与security等关键字段,实现文

weixin_30596165的博客 317

深度学习工具包 DeepLearningToolbox

深度学习工具包Deprecation notice.-----This toolbox is outdated and no longer maintained.There are much better tools available for deep learning than this toolbox, e.g. [Theano](http://deeplearning.net/software/theano/), [torch](http://torch.ch/) or [tensorflow](http://www.tensorflow.org/)I would suggest you use one of the tools mentioned above rather than use this toolbox.Best, Rasmus.DeepLearnToolbox================A Matlab toolbox for Deep Learning.Deep Learning is a new subfield of machine learning that focuses on learning deep hierarchical models of data.It is inspired by the human brain's apparent deep (layered, hierarchical) architecture.A good overview of the theory of Deep Learning theory is[Learning Deep Architectures for AI](http://www.iro.umontreal.ca/~bengioy/papers/ftml_book.pdf)For a more informal introduction, see the following videos by Geoffrey Hinton and Andrew Ng.* [The Next Generation of Neural Networks](http://www.youtube.com/watch?v=AyzOUbkUf3M) (Hinton, 2007)* [Recent Developments in Deep Learning](http://www.youtube.com/watch?v=VdIURAu1-aU) (Hinton, 2010)* [Unsupervised Feature Learning and Deep Learning](http://www.youtube.com/watch?v=ZmNOAtZIgIk) (Ng, 2011)If you use this toolbox in your research please cite [Prediction as a candidate for learning deep hierarchical models of data](http://www2.imm.dtu.dk/pubdb/views/publication_details.php?id=6284)```@MASTERSTHESIS\{IMM2012-06284, author = "R. B. Palm", title = "Prediction as a candidate for learning deep hierarchical models of data", year = "2012",}```Contact: rasmusbergpalm at gmail dot comDirectories included in the toolbox-----------------------------------`NN/` - A library for Feedforward Backpropagation Neural Networks`CNN/` - A library for Convolutional Neural Networks`DBN/` - A library for Deep Belief Networks`SAE/` - A library for Stacked Auto-Encoders`CAE/` - A library for Convolutional Auto-Encoders`util/` - Utility functions used by the libraries`data/` - Data used by the examples`tests/` - unit tests to verify toolbox is workingFor references on each library check REFS.mdSetup-----1. Download.2. addpath(genpath('DeepLearnToolbox'));Example: Deep Belief Network---------------------```matlabfunction test_example_DBNload mnist_uint8;train_x = double(train_x) / 255;test_x = double(test_x) / 255;train_y = double(train_y);test_y = double(test_y);%% ex1 train a 100 hidden unit RBM and visualize its weightsrand('state',0)dbn.sizes = [100];opts.numepochs = 1;opts.batchsize = 100;opts.momentum = 0;opts.alpha = 1;dbn = dbnsetup(dbn, train_x, opts);dbn = dbntrain(dbn, train_x, opts);figure; visualize(dbn.rbm{1}.W'); % Visualize the RBM weights%% ex2 train a 100-100 hidden unit DBN and use its weights to initialize a NNrand('state',0)%train dbndbn.sizes = [100 100];opts.numepochs = 1;opts.batchsize = 100;opts.momentum = 0;opts.alpha = 1;dbn = dbnsetup(dbn, train_x, opts);dbn = dbntrain(dbn, train_x, opts);%unfold dbn to nnnn = dbnunfoldtonn(dbn, 10);nn.activation_function = 'sigm';%train nnopts.numepochs = 1;opts.batchsize = 100;nn = nntrain(nn, train_x, train_y, opts);[er, bad] = nntest(nn, test_x, test_y);assert(er < 0.10, 'Too big error');```Example: Stacked Auto-Encoders---------------------```matlabfunction test_example_SAEload mnist_uint8;train_x = double(train_x)/255;test_x = double(test_x)/255;train_y = double(train_y);test_y = double(test_y);%% ex1 train a 100 hidden unit SDAE and use it to initialize a FFNN% Setup and train a stacked denoising autoencoder (SDAE)rand('state',0)sae = saesetup([784 100]);sae.ae{1}.activation_function = 'sigm';sae.ae{1}.learningRate = 1;sae.ae{1}.inputZeroMaskedFraction = 0.5;opts.numepochs = 1;opts.batchsize = 100;sae = saetrain(sae, train_x, opts);visualize(sae.ae{1}.W{1}(:,2:end)')% Use the SDAE to initialize a FFNNnn = nnsetup([784 100 10]);nn.activation_function = 'sigm';nn.learningRate = 1;nn.W{1} = sae.ae{1}.W{1};% Train the FFNNopts.numepochs = 1;opts.batchsize = 100;nn = nntrain(nn, train_x, train_y, opts);[er, bad] = nntest(nn, test_x, test_y);assert(er < 0.16, 'Too big error');```Example: Convolutional Neural Nets---------------------```matlabfunction test_example_CNNload mnist_uint8;train_x = double(reshape(train_x',28,28,60000))/255;test_x = double(reshape(test_x',28,28,10000))/255;train_y = double(train_y');test_y = double(test_y');%% ex1 Train a 6c-2s-12c-2s Convolutional neural network %will run 1 epoch in about 200 second and get around 11% error. %With 100 epochs you'll get around 1.2% errorrand('state',0)cnn.layers = { struct('type', 'i') %input layer struct('type', 'c', 'outputmaps', 6, 'kernelsize', 5) %convolution layer struct('type', 's', 'scale', 2) %sub sampling layer struct('type', 'c', 'outputmaps', 12, 'kernelsize', 5) %convolution layer struct('type', 's', 'scale', 2) %subsampling layer};cnn = cnnsetup(cnn, train_x, train_y);opts.alpha = 1;opts.batchsize = 50;opts.numepochs = 1;cnn = cnntrain(cnn, train_x, train_y, opts);[er, bad] = cnntest(cnn, test_x, test_y);%plot mean squared errorfigure; plot(cnn.rL);assert(er<0.12, 'Too big error');```Example: Neural Networks---------------------```matlabfunction test_example_NNload mnist_uint8;train_x = double(train_x) / 255;test_x = double(test_x) / 255;train_y = double(train_y);test_y = double(test_y);% normalize[train_x, mu, sigma] = zscore(train_x);test_x = normalize(test_x, mu, sigma);%% ex1 vanilla neural netrand('state',0)nn = nnsetup([784 100 10]);opts.numepochs = 1; % Number of full sweeps through dataopts.batchsize = 100; % Take a mean gradient step over this many samples[nn, L] = nntrain(nn, train_x, train_y, opts);[er, bad] = nntest(nn, test_x, test_y);assert(er < 0.08, 'Too big error');%% ex2 neural net with L2 weight decayrand('state',0)nn = nnsetup([784 100 10]);nn.weightPenaltyL2 = 1e-4; % L2 weight decayopts.numepochs = 1; % Number of full sweeps through dataopts.batchsize = 100; % Take a mean gradient step over this many samplesnn = nntrain(nn, train_x, train_y, opts);[er, bad] = nntest(nn, test_x, test_y);assert(er < 0.1, 'Too big error');%% ex3 neural net with dropoutrand('state',0)nn = nnsetup([784 100 10]);nn.dropoutFraction = 0.5; % Dropout fraction opts.numepochs = 1; % Number of full sweeps through dataopts.batchsize = 100; % Take a mean gradient step over this many samplesnn = nntrain(nn, train_x, train_y, opts);[er, bad] = nntest(nn, test_x, test_y);assert(er < 0.1, 'Too big error');%% ex4 neural net with sigmoid activation functionrand('state',0)nn = nnsetup([784 100 10]);nn.activation_function = 'sigm'; % Sigmoid activation functionnn.learningRate = 1; % Sigm require a lower learning rateopts.numepochs = 1; % Number of full sweeps through dataopts.batchsize = 100; % Take a mean gradient step over this many samplesnn = nntrain(nn, train_x, train_y, opts);[er, bad] = nntest(nn, test_x, test_y);assert(er < 0.1, 'Too big error');%% ex5 plotting functionalityrand('state',0)nn = nnsetup([784 20 10]);opts.numepochs = 5; % Number of full sweeps through datann.output = 'softmax'; % use softmax outputopts.batchsize = 1000; % Take a mean gradient step over this many samplesopts.plot = 1; % enable plottingnn = nntrain(nn, train_x, train_y, opts);[er, bad] = nntest(nn, test_x, test_y);assert(er < 0.1, 'Too big error');%% ex6 neural net with sigmoid activation and plotting of validation and training error% split training data into training and validation datavx = train_x(1:10000,:);tx = train_x(10001:end,:);vy = train_y(1:10000,:);ty = train_y(10001:end,:);rand('state',0)nn = nnsetup([784 20 10]); nn.output = 'softmax'; % use softmax outputopts.numepochs = 5; % Number of full sweeps through dataopts.batchsize = 1000; % Take a mean gradient step over this many samplesopts.plot = 1; % enable plottingnn = nntrain(nn, tx, ty, opts, vx, vy); % nntrain takes validation set as last two arguments (optionally)[er, bad] = nntest(nn, test_x, test_y);assert(er < 0.1, 'Too big error');```[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/rasmusbergpalm/deeplearntoolbox/trend.png)](https://bitdeli.com/free "Bitdeli Badge")

【第五章第6节】API文档自动化测试

本文探讨了API文档自动化测试的重要性及实践方法,通过一个电商平台因文档过时导致生产事故的案例,揭示了文档与实现脱节的严重后果。文章提出API文档测试需解决响应结构不一致、字段变更未更新等核心问题,并划分为结构验证、行为验证和变更管理三个层次。工具选型对比了Schemathesis、Dredd等主流方案,给出决策树指导。重点介绍了OpenAPI规范校验器的实现细节,包括多级验证和最佳实践检查。通过自动化测试可确保API文档与实现始终保持同步,避免"文档漂移"问题。

笑着的程序员的博客 119

win10 跳过U8环境检测的IE WebControls.rar

win10 安装u8的时候 提示IE WebControls 不通过,这个工具可以欺骗u8的检查。 跳过U8环境检测的IE WebControls。提示导入失败后,重新检测通过。

解决JanePHP常见问题:nullable类型处理与版本兼容性完全指南

JanePHP是一套基于JSON Schema和OpenAPI规范生成模型与API客户端的强大工具库。在日常开发中,nullable类型处理和版本兼容性问题是开发者最常遇到的挑战。本文将详细介绍如何在不同规范版本中正确配置nullable属性,以及如何解决版本间的兼容性问题,帮助你轻松应对开发难题。 ## 📊 为什么nullable类型处理如此重要? 在API开发中,字段的可空性(nulla

gitblog_00567的博客 1023

Apple无环境合成数据生成:API调用型LLM智能体训练新范式

API调用是LLM智能体实现外部能力扩展的核心技术,其原理是通过结构化请求与外部服务进行数据交互。在工程实践中,训练能够准确调用API的智能体面临真实数据稀缺、环境依赖性强等挑战。Apple研究人员提出的无环境合成数据生成方法,基于OpenAPI等规格文档,通过模式推断和参数约束分析自动生成高质量训练样本。这种技术显著降低了数据获取成本,避免了生产环境风险,特别适用于企业级AI助手、自动化业务流程等应用场景。该方法为API调用型智能体的规模化训练提供了可行路径,解决了传统方法中的数据瓶颈问题。

cong84596496的博客 374

企业AI智能体治理:从技能契约到GovernSpec框架的工程实践

在构建企业级AI应用时,智能体(Agent)的可靠性与安全性是核心挑战。传统上,智能体的“技能”往往被视作孤立的功能模块,缺乏统一的行为规范与治理标准,这在大规模、多团队协作的生产环境中极易引发稳定性与安全问题。从软件工程角度看,这本质上是服务契约与治理机制的缺失。一套完善的治理规约应明确界定组件的功能边界、性能承诺、安全红线与协作协议,确保其行为可预期、可审计。GovernSpec正是为此提出的设计框架,它将技能从简单的功能描述提升为包含功能接口、性能可靠性、安全合规、协作上下文四大维度的正式契约。通过将

weixin_30727835的博客 420

OpenAPI-Specification部署指南:从本地开发到生产环境

你是否曾在API开发中遇到过这些问题?团队成员对API文档理解不一致、客户端与服务端接口对接反复出错、生产环境中API版本管理混乱?**OpenAPI规范(OAS, OpenAPI Specification)** 正是解决这些问题的行业标准。本指南将系统讲解如何从源码构建、本地验证到生产环境部署OpenAPI规范文档,帮助团队实现API设计的标准化与自动化。 **读完本文你将掌握:** - 环...

gitblog_00836的博客 790

Apispec,一个用于生成 OpenAPI(Swagger)规范的 Python 库

Apispec 是一个用于生成OpenAPI(Swagger)规范的 Python 库。它能够帮助开发者自动生成和维护 API 文档,提供直观、详细的接口说明。通过 Apispec,我们可以轻松地将 Python 函数或类的文档字符串转换为符合 OpenAPI 规范的文档,减少手动编写文档的麻烦。

xyh2004的博客 3002

基于OpenAPI Specification自动生成Android客户端代码

OpenAPI Specification(OAS) Swagger Specification 是一种 API Specification(API 规范),2015 年,SmartBear Software 将 Swagger Specification 捐赠给 Linux Foundation,并改称为 OpenAPI Specification,简称(OAS)。SmartBearSoftware 也作为 OpenAPI Initiative(OAI)的创始成员,该机构以开放和透明的方式管理 OAS

移动端开发干货分享 1806

Go OpenAPI Spec 使用与安装教程

Go OpenAPI Spec 使用与安装教程 欢迎来到Go OpenAPI Spec项目指南!本教程将引导您了解此开源项目的核心要素,包括其目录结构、启动文件以及配置文件的概览,旨在帮助您顺利地集成并利用这个强大的OpenAPI工具。 1. 项目目录结构及介绍 Go OpenAPI Spec项目基于Go语言构建,提供了一套用于处理OpenAPI定义的库。以下是典型的基础目录结构及其简要说明: g...

gitblog_00696的博客 531

Kubernetes API Server源码学习(二):OpenAPI、API Resource的装载、HTTP Server具体是怎么跑起来的?

本文基于Kubernetes v1.22.4版本进行源码学习。

hxt的博客 1852

总结项目中oauth2模块的配置流程及实际业务oauth2认证记录(Spring Security)

项目中用过的spring security,拿来温习一下,一个简单版本的笔记。有问题欢迎大佬们指正!

世上哪有什么岁月静好,不过是有人替你负重前行 2272

go-openapi/spec 项目常见问题解决方案

go-openapi/spec 项目常见问题解决方案 项目基础介绍 go-openapi/spec 是一个用于处理 OpenAPI 规范文档的对象模型库。该项目的主要编程语言是 Go。它提供了将 Swagger API 规范文档序列化和反序列化为 Go 对象模型的功能,并且能够解析和展开 $ref 引用,生成单一的根文档。 新手使用注意事项及解决方案 1. 依赖管理问题 问题描述:新手在使用 go...

gitblog_00043的博客 859
上一篇: Spring Cloud Gateway 、Zuul、EdgeService性能对比
下一篇: 与Apache ServiceComb一起玩开源-北邮站
looook
博客等级 码龄20年 145粉丝 195原创
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明:

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

余额充值