| <!doctype html> |
| <!-- |
| Minimal Mistakes Jekyll Theme 4.4.1 by Michael Rose |
| Copyright 2017 Michael Rose - mademistakes.com | @mmistakes |
| Free for personal and commercial use under the MIT license |
| https://github.com/mmistakes/minimal-mistakes/blob/master/LICENSE.txt |
| --> |
| <html lang="cn" class="no-js"> |
| <head> |
| <meta charset="utf-8"> |
| |
| <!-- begin SEO --> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <title>使用OAS Validator帮助你规范OpenAPI Spec文档 - Apache ServiceComb</title> |
| |
| |
| |
| |
| <meta name="description" content="本文将介绍如何规范你的OpenAPI Spec文档"> |
| |
| |
| |
| |
| <meta name="author" content="Daniel Qian"> |
| |
| <meta property="og:locale" content="cn"> |
| <meta property="og:site_name" content="Apache ServiceComb"> |
| <meta property="og:title" content="使用OAS Validator帮助你规范OpenAPI Spec文档"> |
| |
| |
| <link rel="canonical" href="https://github.com/pages/apache/incubator-servicecomb-website/cn/docs/use-oas-validator-help-standardize-oas-spec/"> |
| <meta property="og:url" content="https://github.com/pages/apache/incubator-servicecomb-website/cn/docs/use-oas-validator-help-standardize-oas-spec/"> |
| |
| |
| |
| <meta property="og:description" content="本文将介绍如何规范你的OpenAPI Spec文档"> |
| |
| |
| |
| <meta name="twitter:site" content="@ServiceComb"> |
| <meta name="twitter:title" content="使用OAS Validator帮助你规范OpenAPI Spec文档"> |
| <meta name="twitter:description" content="本文将介绍如何规范你的OpenAPI Spec文档"> |
| <meta name="twitter:url" content=""> |
| |
| |
| <meta name="twitter:card" content="summary"> |
| |
| |
| |
| |
| <meta name="twitter:creator" content="@"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <meta property="og:type" content="article"> |
| <meta property="article:published_time" content="2019-10-23T00:00:00+08:00"> |
| |
| |
| |
| |
| |
| |
| |
| |
| <script type="application/ld+json"> |
| { |
| "@context" : "http://schema.org", |
| "@type" : "Person", |
| "name" : "Apache ServiceComb", |
| "url" : "https://github.com/pages/apache/incubator-servicecomb-website", |
| "sameAs" : null |
| } |
| </script> |
| |
| |
| |
| <meta name="google-site-verification" content="HvJjNd7vvJ-yjSTHlBiIWEYxp_Hrz-PYEY5Idz9LRcA" /> |
| |
| |
| |
| |
| <!-- end SEO --> |
| |
| |
| <link href="/feed.xml" type="application/atom+xml" rel="alternate" title="Apache ServiceComb Feed"> |
| |
| <!-- http://t.co/dKP3o1e --> |
| <meta name="HandheldFriendly" content="True"> |
| <meta name="MobileOptimized" content="320"> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| |
| <script> |
| document.documentElement.className = document.documentElement.className.replace(/\bno-js\b/g, '') + ' js '; |
| </script> |
| <script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/1.7.1/clipboard.min.js"></script> |
| <script src="/assets/vendor/prism/prism.js"></script> |
| |
| <script type="text/javascript" async |
| src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-MML-AM_CHTML"> |
| </script> |
| |
| <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0-beta/css/bootstrap.min.css" integrity="sha384-/Y6pD6FV/Vv2HJnA6t+vslU6fwYXjCFtcEpHbNJ0lyAFsXTsjBbfaDjzALeQsN6M" crossorigin="anonymous"> |
| |
| <script src="https://www.apachecon.com/event-images/snippet.js"></script> |
| <script src="https://code.jquery.com/jquery-3.2.1.slim.min.js" integrity="sha384-KJ3o2DKtIkvYIK3UENzmM7KCkRr/rE9/Qpg6aAZGJwFDMVNA/GpGFF93hXpG5KkN" crossorigin="anonymous"></script> |
| <script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.11.0/umd/popper.min.js" integrity="sha384-b/U6ypiBEHpOf/4+1nzFpr53nxSS+GLCkfwBdFNTxtclqqenISfwAzpKaMNFNmj4" crossorigin="anonymous"></script> |
| <script src="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0-beta/js/bootstrap.min.js" integrity="sha384-h0AbiXch4ZDo7tp9hKZ4TsHbi047NrKGLO3SEJAg45jXxnGIfYzk4Si90RDIqNm1" crossorigin="anonymous"></script> |
| <!-- For all browsers --> |
| <link rel="stylesheet" href="/assets/css/main.css"> |
| <link rel="stylesheet" href="/assets/vendor/prism/prism.css"> |
| |
| <!--[if lte IE 9]> |
| <style> |
| /* old IE unsupported flexbox fixes */ |
| .greedy-nav .site-title { |
| padding-right: 3em; |
| } |
| .greedy-nav button { |
| position: absolute; |
| top: 0; |
| right: 0; |
| height: 100%; |
| } |
| </style> |
| <![endif]--> |
| |
| <meta http-equiv="cleartype" content="on"> |
| |
| <!-- start custom head snippets --> |
| |
| <!-- insert favicons. use http://realfavicongenerator.net/ --> |
| <link href="https://fonts.loli.net/css?family=Roboto:400,500,700|Source+Code+Pro" rel="stylesheet"> |
| <script src="/assets/js/custom.js"></script> |
| <!-- end custom head snippets --> |
| |
| </head> |
| |
| <body class="layout--single"> |
| |
| <!--[if lt IE 9]> |
| <div class="notice--danger align-center" style="margin: 0;">You are using an <strong>outdated</strong> browser. Please <a href="http://browsehappy.com/">upgrade your browser</a> to improve your experience.</div> |
| <![endif]--> |
| <div class="masthead" onmouseleave="$('#childrenShow').css('display', 'none')"> |
| <div class="masthead__inner-wrap"> |
| <div class="masthead__menu"> |
| <nav id="site-nav" class="greedy-nav"> |
| |
| <a class="site-title active" href="/cn"><img src="https://www.apache.org/img/servicecomb.png"></a> |
| |
| <ul class="visible-links"> |
| |
| |
| |
| |
| |
| <li class="masthead__menu-item" onmouseenter="$('#childrenShow').css('display', 'none')"> |
| |
| <a href="/cn/">首页</a> |
| |
| </li> |
| |
| |
| |
| |
| |
| |
| <li class="masthead__menu-item" onmouseenter="$('#childrenShow').css('display', 'none')"> |
| |
| <a href="/cn/developers/">项目</a> |
| |
| </li> |
| |
| |
| |
| |
| |
| |
| <li class="def-nav-li" onmouseenter="$('#childrenShow').css('display', 'block')"> |
| |
| |
| |
| |
| |
| <a href="/cn/docs/users/">文档</a> |
| |
| |
| <ul id="childrenShow" class="def-children-show-cn" onmouseleave="$('#childrenShow').css('display', 'none')"> |
| |
| <li><a href="/cn/docs/getting-started/" class="">入门指南</a></li> |
| |
| <li><a href="/cn/docs/users/" class="">用户手册</a></li> |
| |
| <li><a href="/cn/slides/" class="">大咖视频</a></li> |
| |
| <li><a href="/cn/faqs/" class="">常见问题</a></li> |
| |
| </ul> |
| </li> |
| |
| |
| |
| |
| |
| |
| <li class="masthead__menu-item" onmouseenter="$('#childrenShow').css('display', 'none')"> |
| |
| <a href="/cn/year-archive/">博文</a> |
| |
| </li> |
| |
| |
| |
| |
| |
| |
| <li class="masthead__menu-item" onmouseenter="$('#childrenShow').css('display', 'none')"> |
| |
| <a href="/cn/release/">下载</a> |
| |
| </li> |
| |
| |
| </ul> |
| <button><div class="navicon"></div></button> |
| <ul class="hidden-links hidden"></ul> |
| <div class="nav-lang"> |
| |
| |
| |
| <a href=/docs/use-oas-validator-help-standardize-oas-spec/>English</a> |
| |
| </div> |
| </nav> |
| </div> |
| </div> |
| </div> |
| |
| |
| |
| |
| |
| |
| <div id="main" role="main"> |
| |
| <div class="sidebar sticky"> |
| |
| <div class="back-to-home"><a href="/cn/">首页</a> > 使用OAS Validator帮助你规范OpenAPI Spec文档</div> |
| |
| |
| |
| <div itemscope itemtype="http://schema.org/Person"> |
| |
| |
| |
| <div class="author__content"> |
| <h3 class="author__name" itemprop="name">Qian Jia</h3> |
| |
| <p class="author__bio" itemprop="description"> |
| |
| |
| Opensource change the world |
| |
| |
| </p> |
| |
| </div> |
| |
| <div class="author__urls-wrapper"> |
| <button class="btn btn--inverse">关注</button> |
| <ul class="author__urls social-icons"> |
| |
| |
| |
| <li> |
| <a href="https://github.com/chanjarster" itemprop="url"> |
| <i class="fa fa-fw fa-chain" aria-hidden="true"></i> 网站 |
| </a> |
| </li> |
| |
| |
| |
| <li> |
| <a href="mailto:chanjarster@gmail.com"> |
| <meta itemprop="email" content="chanjarster@gmail.com" /> |
| <i class="fa fa-fw fa-envelope-square" aria-hidden="true"></i> 电子邮箱 |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <!-- |
| <li> |
| <a href="http://link-to-whatever-social-network.com/user/" itemprop="sameAs"> |
| <i class="fa fa-fw" aria-hidden="true"></i> Custom Social Profile Link |
| </a> |
| </li> |
| --> |
| </ul> |
| </div> |
| </div> |
| |
| |
| </div> |
| |
| |
| |
| <article class="page" itemscope itemtype="http://schema.org/CreativeWork"> |
| <meta itemprop="headline" content="使用OAS Validator帮助你规范OpenAPI Spec文档"> |
| <meta itemprop="description" content="本文将介绍如何规范你的OpenAPI Spec文档"> |
| <meta itemprop="datePublished" content="October 23, 2019"> |
| <meta itemprop="dateModified" content="October 23, 2019"> |
| |
| <div class="page__inner-wrap"> |
| |
| |
| <header> |
| <h1 class="page__title" itemprop="headline">使用OAS Validator帮助你规范OpenAPI Spec文档 |
| </h1> |
| |
| <p class="page__meta"><i class="fa fa-clock-o" aria-hidden="true"></i> |
| |
| |
| |
| |
| 1 分钟 阅读 |
| |
| </p> |
| |
| </header> |
| |
| |
| |
| <section class="page__content" itemprop="text"> |
| <h2 id="使用oas-validator规范你的openapi-spec文档">使用OAS Validator规范你的OpenAPI Spec文档</h2> |
| |
| <p>当前主流的开发RESTful API的做法有两种：Code First和Contract First。Code First指先写代码，然后生成Contract，而Contract First则是先写Contract再写代码实现。</p> |
| |
| <p>两种做法各有利弊，Code First可以让开发人员先写接口实现，然后利用工具反向生成Contract，优点是快速开发，并能保证接口实现与Contract保证一致，缺点是Contract太过易变容易导致下游应用故障。Contract First则可以让Contract的变动受控，保证下游应用的稳定性，缺点是需要人工来保证接口实现与Contact的一致性，具有一定难度。</p> |
| |
| <p>对于如何规范管理Contract，新开普软件研究院开源的<a href="https://github.com/NewCapec-Institute/oas-validator">OAS Validator[1]</a>提供了一些思路，下面简单介绍。</p> |
| |
| <h3 id="合规性校验">合规性校验</h3> |
| |
| <p>OAS Validator支持对使用<a href="https://github.com/OAI/OpenAPI-Specification">OpenAPI V3[2]</a>编写的Contract文档做合规性校验（也可称之为风格校验）。</p> |
| |
| <p>在一个微服务架构的系统中，提供RESTful API的组件可能会有很多个，并且由不同开发人员/团队开发，那么在使用这些接口的时候有一个很自然的需求就是希望这些接口（或接口文档）的风格是一致的。OAS Validator的合规性校验做的就是这部分工作。下面举例说明怎么使用合规性校验功能：</p> |
| |
| <ol> |
| <li>到 https://github.com/NewCapec-Institute/oas-validator clone下代码</li> |
| <li>然后 <code class="language-plaintext highlighter-rouge">mvn clean install</code>打包</li> |
| <li>到<code class="language-plaintext highlighter-rouge">oas-validator-web/target</code>目录下执行<code class="language-plaintext highlighter-rouge">java -jar oas-validator-web-exec.jar</code>启动OAS Validator Web</li> |
| <li>访问 http://localhost:8080，进入合规性校验功能</li> |
| <li>把 <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/examples/v3.0/petstore.yaml">petstore.yaml</a> 内容贴到文本框中然后点击校验得到结果：</li> |
| </ol> |
| |
| <pre><code class="language-txt">$.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所定义的范围内 |
| </code></pre> |
| |
| <p>下面是功能截图：</p> |
| |
| <p><img src="/assets/images/2019-10-23-use-oas-validator-help-standardize-oas-spec/oas-validator-1.png" alt="图1 合规性校验" class="align-center" /></p> |
| |
| <p>下面举例解释检查报告的意思：</p> |
| |
| <p><code class="language-plaintext highlighter-rouge">$.components.schemas.'Pet'.title : 必须提供</code>，前面一段是<a href="https://github.com/json-path/JsonPath">JsonPath[3]</a>，用来描述出问题的元素/属性的位置，“必须提供”则的意思是没有填写该属性。如下图：</p> |
| |
| <p><img src="/assets/images/2019-10-23-use-oas-validator-help-standardize-oas-spec/oas-validator-2.png" alt="图2 合规性校验示例" class="align-center" /></p> |
| |
| <p><code class="language-plaintext highlighter-rouge">title</code>是一个文档性字段，没有它虽然不影响接口的语义，但是对于下游应用的开发者来说没有它会造成理解上的困难，因此在这里我们把它设定为必填。</p> |
| |
| <p>再来看这一条报告 <code class="language-plaintext highlighter-rouge">$.paths./pets.get.responses.200.headers.'x-next' : 必须为upper hyphen case</code>，同样前面是JsonPath，告诉你该属性应该为Upper Hyphen Case，正确的写法应该是<code class="language-plaintext highlighter-rouge">X-Next</code>。和<code class="language-plaintext highlighter-rouge">title</code>属性一样Header的大小写不是一个技术问题，但是统一的大小写风格能够让下游应用的开发人员更舒适，从而有更少的Bug。</p> |
| |
| <h3 id="兼容性校验">兼容性校验</h3> |
| |
| <p>不管你是采用Code First还是Contract First，Contract的变动不可避免，那么如何保证变化后的Contract能够对下游应用向下兼容就成了不可回避的问题。这个问题的具体描述就是根据V1.0 Contract开发的下游应用是否依然能够与根据V1.1 Contract实现的接口正确交互。</p> |
| |
| <p>OAS Validator提供了这种兼容性校验，当然同样只支持OpenAPI V3文档。下面举例说明如何使用这一功能：</p> |
| |
| <p>我们先提供一个v1.0的OAS Spec：</p> |
| |
| <div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">openapi</span><span class="pi">:</span> <span class="s2">"</span><span class="s">3.0.0"</span> |
| <span class="na">info</span><span class="pi">:</span> |
| <span class="na">version</span><span class="pi">:</span> <span class="m">1.0</span> |
| <span class="na">title</span><span class="pi">:</span> <span class="s">Swagger Petstore</span> |
| <span class="na">paths</span><span class="pi">:</span> |
| <span class="s">/pets/{petId}</span><span class="pi">:</span> |
| <span class="na">get</span><span class="pi">:</span> |
| <span class="na">operationId</span><span class="pi">:</span> <span class="s">showPetById</span> |
| <span class="na">tags</span><span class="pi">:</span> |
| <span class="pi">-</span> <span class="s">pets</span> |
| <span class="na">parameters</span><span class="pi">:</span> |
| <span class="pi">-</span> <span class="na">name</span><span class="pi">:</span> <span class="s">petId</span> |
| <span class="na">in</span><span class="pi">:</span> <span class="s">path</span> |
| <span class="na">required</span><span class="pi">:</span> <span class="no">true</span> |
| <span class="na">schema</span><span class="pi">:</span> |
| <span class="na">type</span><span class="pi">:</span> <span class="s">string</span> |
| <span class="na">responses</span><span class="pi">:</span> |
| <span class="s1">'</span><span class="s">200'</span><span class="pi">:</span> |
| <span class="na">description</span><span class="pi">:</span> <span class="s">Expected response to a valid request</span> |
| <span class="na">content</span><span class="pi">:</span> |
| <span class="s">application/json</span><span class="pi">:</span> |
| <span class="na">schema</span><span class="pi">:</span> |
| <span class="s">$ref</span><span class="pi">:</span> <span class="s2">"</span><span class="s">#/components/schemas/Pet"</span> |
| <span class="na">components</span><span class="pi">:</span> |
| <span class="na">schemas</span><span class="pi">:</span> |
| <span class="na">Pet</span><span class="pi">:</span> |
| <span class="na">type</span><span class="pi">:</span> <span class="s">object</span> |
| <span class="na">required</span><span class="pi">:</span> |
| <span class="pi">-</span> <span class="s">id</span> |
| <span class="pi">-</span> <span class="s">name</span> |
| <span class="na">properties</span><span class="pi">:</span> |
| <span class="na">id</span><span class="pi">:</span> |
| <span class="na">type</span><span class="pi">:</span> <span class="s">integer</span> |
| <span class="na">format</span><span class="pi">:</span> <span class="s">int64</span> |
| <span class="na">name</span><span class="pi">:</span> |
| <span class="na">type</span><span class="pi">:</span> <span class="s">string</span> |
| </code></pre></div></div> |
| |
| <p>再写一个v1.1的OAS Spec，添加了一个query参数<code class="language-plaintext highlighter-rouge">name</code>：</p> |
| |
| <div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">openapi</span><span class="pi">:</span> <span class="s2">"</span><span class="s">3.0.0"</span> |
| <span class="na">info</span><span class="pi">:</span> |
| <span class="na">version</span><span class="pi">:</span> <span class="m">1.1</span> |
| <span class="na">title</span><span class="pi">:</span> <span class="s">Swagger Petstore</span> |
| <span class="na">paths</span><span class="pi">:</span> |
| <span class="s">/pets/{petId}</span><span class="pi">:</span> |
| <span class="na">get</span><span class="pi">:</span> |
| <span class="na">operationId</span><span class="pi">:</span> <span class="s">showPetById</span> |
| <span class="na">tags</span><span class="pi">:</span> |
| <span class="pi">-</span> <span class="s">pets</span> |
| <span class="na">parameters</span><span class="pi">:</span> |
| <span class="pi">-</span> <span class="na">name</span><span class="pi">:</span> <span class="s">petId</span> |
| <span class="na">in</span><span class="pi">:</span> <span class="s">path</span> |
| <span class="na">required</span><span class="pi">:</span> <span class="no">true</span> |
| <span class="na">schema</span><span class="pi">:</span> |
| <span class="na">type</span><span class="pi">:</span> <span class="s">string</span> |
| <span class="pi">-</span> <span class="na">name</span><span class="pi">:</span> <span class="s">name</span> |
| <span class="na">in</span><span class="pi">:</span> <span class="s">query</span> |
| <span class="na">required</span><span class="pi">:</span> <span class="no">true</span> |
| <span class="na">schema</span><span class="pi">:</span> |
| <span class="na">type</span><span class="pi">:</span> <span class="s">string</span> |
| <span class="na">responses</span><span class="pi">:</span> |
| <span class="s1">'</span><span class="s">200'</span><span class="pi">:</span> |
| <span class="na">description</span><span class="pi">:</span> <span class="s">Expected response to a valid request</span> |
| <span class="na">content</span><span class="pi">:</span> |
| <span class="s">application/json</span><span class="pi">:</span> |
| <span class="na">schema</span><span class="pi">:</span> |
| <span class="s">$ref</span><span class="pi">:</span> <span class="s2">"</span><span class="s">#/components/schemas/Pet"</span> |
| <span class="na">components</span><span class="pi">:</span> |
| <span class="na">schemas</span><span class="pi">:</span> |
| <span class="na">Pet</span><span class="pi">:</span> |
| <span class="na">type</span><span class="pi">:</span> <span class="s">object</span> |
| <span class="na">required</span><span class="pi">:</span> |
| <span class="pi">-</span> <span class="s">id</span> |
| <span class="pi">-</span> <span class="s">name</span> |
| <span class="na">properties</span><span class="pi">:</span> |
| <span class="na">id</span><span class="pi">:</span> |
| <span class="na">type</span><span class="pi">:</span> <span class="s">integer</span> |
| <span class="na">format</span><span class="pi">:</span> <span class="s">int64</span> |
| <span class="na">name</span><span class="pi">:</span> |
| <span class="na">type</span><span class="pi">:</span> <span class="s">string</span> |
| </code></pre></div></div> |
| |
| <p>然后同样打开OAS Validator Web，进入“兼容性校验”功能，在左侧贴上v1.0在右侧贴上v1.1，点击校验得到结果：</p> |
| |
| <pre><code class="language-txt">$.paths./pets/{petId}.get.parameters[1].required : [name=name,in=query]:仅允许新增required=false的parameter |
| </code></pre> |
| |
| <p>这个报告的意思是新增的query参数<code class="language-plaintext highlighter-rouge">name</code>是必填的，这种做法不向下兼容。仔细想想是不是的确如此？</p> |
| |
| <h3 id="总结">总结</h3> |
| |
| <p>关于OAS Validator的详细文档可见Github。需要注意的是，目前校验规则还不能配置，但是在代码层面提供了接口供扩展，你可以根据自己的需求写一个自己的合规性校验器。</p> |
| |
| <p>同时OAS Validator正在请求捐赠到<a href="https://github.com/apache/servicecomb-toolkit">Servicecomb Toolkit[4]</a>项目，流程结束后会尽快将其整合到Servicecomb Toolkit中希望能够为广大开发者带来帮助。</p> |
| |
| <p>最后，欢迎开发者朋友们加入ServiceComb社区，一起做些有意思的事情。<a href="http://servicecomb.incubator.apache.org/cn/docs/join_the_community/">加入社区方法[5]</a></p> |
| |
| <h3 id="参考资料">参考资料</h3> |
| |
| <p>[1] OAS Validator https://github.com/NewCapec-Institute/oas-validator</p> |
| |
| <p>[2] OpenAPI V3 https://github.com/OAI/OpenAPI-Specification</p> |
| |
| <p>[3] JsonPath https://github.com/json-path/JsonPath</p> |
| |
| <p>[4] Servicecomb Toolkit https://github.com/apache/servicecomb-toolkit</p> |
| |
| <p>[5] 加入Servicecomb社区 http://servicecomb.incubator.apache.org/cn/docs/join_the_community/</p> |
| |
| |
| </section> |
| |
| <footer class="page__meta"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <p class="page__taxonomy"> |
| <strong><i class="fa fa-fw fa-tags" aria-hidden="true"></i> 标签: </strong> |
| <span itemprop="keywords"> |
| |
| |
| |
| <a href="/tags/#%E5%BE%AE%E6%9C%8D%E5%8A%A1" class="page__taxonomy-item" rel="tag">微服务</a> |
| |
| </span> |
| </p> |
| |
| |
| |
| |
| |
| |
| |
| |
| <p class="page__date"><strong><i class="fa fa-fw fa-calendar" aria-hidden="true"></i> 最新的:</strong> <time datetime="2019-10-23">2019年10月23日</time></p> |
| |
| |
| |
| </footer> |
| |
| <section class="page__share"> |
| |
| <h4 class="page__share-title">分享</h4> |
| |
| |
| <a href="https://twitter.com/intent/tweet?via=ServiceComb&text=使用OAS Validator帮助你规范OpenAPI Spec文档 /cn/docs/use-oas-validator-help-standardize-oas-spec/" class="btn btn--twitter" title="分享 Twitter"><i class="fa fa-fw fa-twitter" aria-hidden="true"></i><span> Twitter</span></a> |
| |
| <a href="https://www.facebook.com/sharer/sharer.php?u=/cn/docs/use-oas-validator-help-standardize-oas-spec/" class="btn btn--facebook" title="分享 Facebook"><i class="fa fa-fw fa-facebook" aria-hidden="true"></i><span> Facebook</span></a> |
| |
| <a href="https://plus.google.com/share?url=/cn/docs/use-oas-validator-help-standardize-oas-spec/" class="btn btn--google-plus" title="分享 Google Plus"><i class="fa fa-fw fa-google-plus" aria-hidden="true"></i><span> Google+</span></a> |
| |
| <a href="https://www.linkedin.com/shareArticle?mini=true&url=/cn/docs/use-oas-validator-help-standardize-oas-spec/" class="btn btn--linkedin" title="分享 LinkedIn"><i class="fa fa-fw fa-linkedin" aria-hidden="true"></i><span> LinkedIn</span></a> |
| </section> |
| |
| |
| |
| <nav class="pagination"> |
| |
| <a href="/cn/docs/Apache-ServiceComb-Meetup-2019-Shanghai-Report/" class="pagination--pager" title="Apache ServiceComb Meetup -Shanghai 2019.09.20 Report (PPT Download) |
| ">向前</a> |
| |
| |
| <a href="/cn/docs/servicecomb-accept-newcapec-institute-code-donation/" class="pagination--pager" title="Apache ServiceComb社区接受新开普软件研究院的代码捐赠 |
| ">向后</a> |
| |
| </nav> |
| |
| |
| </div> |
| |
| |
| <div class="page__comments"> |
| |
| |
| <section id="static-comments"> |
| |
| <!-- Start static comments --> |
| <div class="js-comments"> |
| |
| </div> |
| <!-- End static comments --> |
| |
| <!-- Start new comment form --> |
| <h4 class="page__comments-title">留下评论</h4> |
| <p class="small">您的电子邮箱地址并不会被展示。请填写标记为必须的字段。 <span class="required">*</span></p> |
| <form id="new_comment" class="page__comments-form js-form form" method="post" action="https://api.staticman.net/v1/entry/apache/incubator-servicecomb-website/master"> |
| <div class="form__spinner"> |
| <i class="fa fa-spinner fa-spin fa-3x fa-fw"></i> |
| <span class="sr-only">正在加载...</span> |
| </div> |
| |
| <fieldset> |
| <label for="comment-form-message">评论 <small class="required">*</small></label> |
| <textarea type="text" rows="3" id="comment-form-message" name="fields[message]" tabindex="1"></textarea> |
| <div class="small help-block"><a href="https://daringfireball.net/projects/markdown/">Markdown语法已支持。</a></div> |
| </fieldset> |
| <fieldset> |
| <label for="comment-form-name">姓名 <small class="required">*</small></label> |
| <input type="text" id="comment-form-name" name="fields[name]" tabindex="2" /> |
| </fieldset> |
| <fieldset> |
| <label for="comment-form-email">电子邮箱 <small class="required">*</small></label> |
| <input type="email" id="comment-form-email" name="fields[email]" tabindex="3" /> |
| </fieldset> |
| <fieldset> |
| <label for="comment-form-url">网站（可选）</label> |
| <input type="url" id="comment-form-url" name="fields[url]" tabindex="4"/> |
| </fieldset> |
| <fieldset class="hidden" style="display: none;"> |
| <input type="hidden" name="options[slug]" value="use-oas-validator-help-standardize-oas-spec"> |
| <label for="comment-form-location">Not used. Leave blank if you are a human.</label> |
| <input type="text" id="comment-form-location" name="fields[hidden]" autocomplete="off"/> |
| </fieldset> |
| <!-- Start comment form alert messaging --> |
| <p class="hidden js-notice"> |
| <strong class="js-notice-text"></strong> |
| </p> |
| <!-- End comment form alert messaging --> |
| <fieldset> |
| <button type="submit" id="comment-form-submit" tabindex="5" class="btn btn--large">提交评论</button> |
| </fieldset> |
| </form> |
| <!-- End new comment form --> |
| |
| </section> |
| |
| </div> |
| |
| |
| </article> |
| |
| |
| |
| <div class="page__related"> |
| <h4 class="page__related-title">猜您还喜欢</h4> |
| <div class="grid__wrapper"> |
| |
| |
| |
| |
| |
| <div class="grid__item"> |
| <article class="archive__item" itemscope itemtype="http://schema.org/CreativeWork"> |
| |
| <h2 class="archive__item-title" itemprop="headline"> |
| |
| <a href="/cn/docs/playing-on-the-open-source-community-with-Apache-ServiceComb-GDUT/" rel="permalink">与Apache ServiceComb一起玩开源-广工站 (PPT Download) |
| </a> |
| |
| </h2> |
| <p class="archive__item-excerpt" itemprop="description">与Apache ServiceComb一起玩开源-广工站 (PPT Download) |
| </p> |
| |
| <p class="page__meta"><i class="fa fa-clock-o" aria-hidden="true"></i> |
| |
| |
| |
| |
| 少于 1 分钟 阅读 |
| |
| </p> |
| |
| </article> |
| </div> |
| |
| |
| |
| |
| |
| |
| <div class="grid__item"> |
| <article class="archive__item" itemscope itemtype="http://schema.org/CreativeWork"> |
| |
| <h2 class="archive__item-title" itemprop="headline"> |
| |
| <a href="/cn/docs/servicecomb-service-center-client/" rel="permalink">使用ServiceComb客户端轻松调用ServiceCenter |
| </a> |
| |
| </h2> |
| <p class="archive__item-excerpt" itemprop="description">使用ServiceComb客户端轻松调用ServiceCenter |
| </p> |
| |
| <p class="page__meta"><i class="fa fa-clock-o" aria-hidden="true"></i> |
| |
| |
| |
| |
| 2 分钟 阅读 |
| |
| </p> |
| |
| </article> |
| </div> |
| |
| |
| |
| |
| |
| |
| <div class="grid__item"> |
| <article class="archive__item" itemscope itemtype="http://schema.org/CreativeWork"> |
| |
| <h2 class="archive__item-title" itemprop="headline"> |
| |
| <a href="/cn/docs/playing-on-the-open-source-community-with-Apache-ServiceComb-BUPT/" rel="permalink">与Apache ServiceComb一起玩开源-北邮站 (PPT Download) |
| </a> |
| |
| </h2> |
| <p class="archive__item-excerpt" itemprop="description">与Apache ServiceComb一起玩开源-北邮站 (PPT Download) |
| </p> |
| |
| <p class="page__meta"><i class="fa fa-clock-o" aria-hidden="true"></i> |
| |
| |
| |
| |
| 少于 1 分钟 阅读 |
| |
| </p> |
| |
| </article> |
| </div> |
| |
| |
| |
| |
| |
| |
| <div class="grid__item"> |
| <article class="archive__item" itemscope itemtype="http://schema.org/CreativeWork"> |
| |
| <h2 class="archive__item-title" itemprop="headline"> |
| |
| <a href="/docs/servicecomb-accept-newcapec-institute-code-donation/" rel="permalink">Apache ServiceComb Accept Code Donation From NewCapec Institute |
| </a> |
| |
| </h2> |
| <p class="archive__item-excerpt" itemprop="description">Apache ServiceComb Accept Code Donation From NewCapec Institute |
| </p> |
| |
| <p class="page__meta"><i class="fa fa-clock-o" aria-hidden="true"></i> |
| |
| |
| |
| |
| 少于 1 分钟 阅读 |
| |
| </p> |
| |
| </article> |
| </div> |
| |
| |
| </div> |
| </div> |
| |
| </div> |
| |
| |
| <script async src="//pagead2.googlesyndication.com/pagead/js/adsbygoogle.js"></script> |
| <div align="center" style="margin: 0 0;"> |
| <ins class="adsbygoogle" |
| style="display:block; border-bottom: initial;" |
| data-ad-client="ca-pub-7328585512091257" |
| data-ad-slot="3049671934" |
| data-ad-format="auto"></ins> |
| </div> |
| |
| <div class="page__footer"> |
| <footer> |
| <!-- start custom footer snippets --> |
| |
| <!-- end custom footer snippets --> |
| |
| <div class="container"> |
| <div class="row justify-content-md-center"> |
| |
| <div class="col"> |
| <ul> |
| <p class="header">活动</p> |
| <a class="acevent" data-format="square" data-mode="dark" data-event="random"></a> |
| </ul> |
| </div> |
| <div class="col"> |
| <ul> |
| <p class="header">资源</p> |
| <li><a href="/cn/docs/getting-started/">入门指南</a></li> |
| <li><a href="/cn/docs/users/">用户指南</a></li> |
| <li><a href="/cn/slides/">资料</a></li> |
| <li><a href="/cn/users/faq/">常见问题</a></li> |
| </ul> |
| </div> |
| <div class="col"> |
| <ul> |
| <p class="header">ASF</p> |
| <li><a href="http://www.apache.org">基金会</a></li> |
| <li><a href="http://www.apache.org/licenses/">许可证</a></li> |
| <li><a href="http://www.apache.org/events/current-event">活动</a></li> |
| <li><a href="http://www.apache.org/foundation/sponsorship.html">赞助</a></li> |
| <li><a href="http://www.apache.org/foundation/thanks.html">鸣谢</a></li> |
| </ul> |
| </div> |
| <div class="col"> |
| <ul> |
| <p class="header">贡献</p> |
| <li><a href="http://issues.apache.org/jira/browse/SCB">报告本网页问题</a></li> |
| <li><a href="https://github.com/apache/servicecomb-website/edit/master/_posts/cn/2019-10-23-use-oas-validator-help-standardize-oas-spec.md">在Github上编辑此页</a></li> |
| <li><a href="/cn/developers/submit-codes/">代码提交指南</a></li> |
| <li><a href="/cn/security">安全</a></li> |
| </ul> |
| </div> |
| <div class="col"> |
| <ul class="social-icons"> |
| <p class="header">社区</p> |
| <li> |
| <a href="mailto:dev-subscribe@servicecomb.incubator.apache.org" rel="nofollow"><span class="mail">邮件列表</span></a> |
| </li> |
| <li> |
| <a href="https://github.com/apache?q=ServiceComb" target="_blank"><span class="github">Github</span></a> |
| </li> |
| <li> |
| <a href="https://twitter.com/ServiceComb" target="_blank"><span class="twitter">Twitter</span></a> |
| </li> |
| <li> |
| <a href="/feed.xml" target="_blank"><span class="rss">Feed</span></a> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="page__footer-bottom"> |
| <div>© 2024 Apache ServiceComb. 技术来自于 <a href="http://jekyllrb.com" rel="nofollow">Jekyll</a> & <a href="https://mademistakes.com/work/minimal-mistakes-jekyll-theme/" rel="nofollow">Minimal Mistakes</a>.</div> |
| <div>All other marks mentioned may be trademarks or registered trademarks of their respective owners.</div> |
| </div> |
| |
| </footer> |
| </div> |
| |
| <script src="/assets/js/main.min.js"></script> |
| |
| |
| |
| |
| <script> |
| (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ |
| (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), |
| m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) |
| })(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); |
| |
| ga('create', 'UA-101622733-1', 'auto'); |
| ga('send', 'pageview'); |
| </script> |
| |
| |
| |
| |
| |
| |
| |
| |
| <script> |
| (function ($) { |
| var $comments = $('.js-comments'); |
| |
| $('#new_comment').submit(function () { |
| var form = this; |
| |
| $(form).addClass('disabled'); |
| $('#comment-form-submit').html('<i class="fa fa-spinner fa-spin fa-fw"></i> 正在加载...'); |
| |
| $.ajax({ |
| type: $(this).attr('method'), |
| url: $(this).attr('action'), |
| data: $(this).serialize(), |
| contentType: 'application/x-www-form-urlencoded', |
| success: function (data) { |
| $('#comment-form-submit').html('已提交'); |
| $('.page__comments-form .js-notice').removeClass('notice--danger'); |
| $('.page__comments-form .js-notice').addClass('notice--success'); |
| showAlert('感谢您的评论！被批准后它会立即在此站点展示。'); |
| }, |
| error: function (err) { |
| console.log(err); |
| $('#comment-form-submit').html('提交评论'); |
| $('.page__comments-form .js-notice').removeClass('notice--success'); |
| $('.page__comments-form .js-notice').addClass('notice--danger'); |
| showAlert('很抱歉，您的提交存在错误。请确保所有必填字段都已填写正确，然后再试一次。'); |
| $(form).removeClass('disabled'); |
| } |
| }); |
| |
| return false; |
| }); |
| |
| function showAlert(message) { |
| $('.page__comments-form .js-notice').removeClass('hidden'); |
| $('.page__comments-form .js-notice-text').html(message); |
| } |
| })(jQuery); |
| </script> |
| |
| |
| |
| |
| |
| |
| |
| </body> |
| </html> |
