forked from loafle/openapi-generator-original
1 line
3.8 KiB
JavaScript
1 line
3.8 KiB
JavaScript
"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[4711],{3905:function(e,t,n){n.d(t,{Zo:function(){return s},kt:function(){return m}});var r=n(7294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function a(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?i(Object(n),!0).forEach((function(t){o(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):i(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function c(e,t){if(null==e)return{};var n,r,o=function(e,t){if(null==e)return{};var n,r,o={},i=Object.keys(e);for(r=0;r<i.length;r++)n=i[r],t.indexOf(n)>=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r<i.length;r++)n=i[r],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var p=r.createContext({}),l=function(e){var t=r.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):a(a({},t),e)),n},s=function(e){var t=l(e.components);return r.createElement(p.Provider,{value:t},e.children)},u="mdxType",f={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},d=r.forwardRef((function(e,t){var n=e.components,o=e.mdxType,i=e.originalType,p=e.parentName,s=c(e,["components","mdxType","originalType","parentName"]),u=l(n),d=o,m=u["".concat(p,".").concat(d)]||u[d]||f[d]||i;return n?r.createElement(m,a(a({ref:t},s),{},{components:n})):r.createElement(m,a({ref:t},s))}));function m(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var i=n.length,a=new Array(i);a[0]=d;var c={};for(var p in t)hasOwnProperty.call(t,p)&&(c[p]=t[p]);c.originalType=e,c[u]="string"==typeof e?e:o,a[1]=c;for(var l=2;l<i;l++)a[l]=n[l];return r.createElement.apply(null,a)}return r.createElement.apply(null,n)}d.displayName="MDXCreateElement"},778:function(e,t,n){n.r(t),n.d(t,{assets:function(){return s},contentTitle:function(){return p},default:function(){return d},frontMatter:function(){return c},metadata:function(){return l},toc:function(){return u}});var r=n(7462),o=n(3366),i=(n(7294),n(3905)),a=["components"],c={id:"spec-info",title:"Spec Info"},p=void 0,l={unversionedId:"spec-info",id:"spec-info",title:"Spec Info",description:"OpenAPI",source:"@site/../docs/specification-info.md",sourceDirName:".",slug:"/spec-info",permalink:"/docs/spec-info",draft:!1,editUrl:"https://github.com/OpenAPITools/openapi-generator/edit/master/website/../docs/specification-info.md",tags:[],version:"current",lastUpdatedBy:"Jim Schubert",lastUpdatedAt:1547804373,formattedLastUpdatedAt:"Jan 18, 2019",frontMatter:{id:"spec-info",title:"Spec Info"}},s={},u=[{value:"OpenAPI",id:"openapi",level:2},{value:"2.0",id:"20",level:3},{value:"3.x",id:"3x",level:3},{value:"Tags",id:"tags",level:3}],f={toc:u};function d(e){var t=e.components,n=(0,o.Z)(e,a);return(0,i.kt)("wrapper",(0,r.Z)({},f,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("h2",{id:"openapi"},"OpenAPI"),(0,i.kt)("h3",{id:"20"},"2.0"),(0,i.kt)("h3",{id:"3x"},"3.x"),(0,i.kt)("h3",{id:"tags"},"Tags"),(0,i.kt)("p",null,"Tags basically group endpoints into the same API class file. For example, an endpoint with the ",(0,i.kt)("inlineCode",{parentName:"p"},"store")," tag will be generated in the StoreApi class file in most generators."),(0,i.kt)("p",null,"Ref: ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#tagObject"},"https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#tagObject")))}d.isMDXComponent=!0}}]); |