2018-02-02 12:49:20 +00:00
<!DOCTYPE HTML>
< html lang = "" >
< head >
< meta charset = "UTF-8" >
< meta content = "text/html; charset=utf-8" http-equiv = "Content-Type" >
2018-02-11 19:36:11 +00:00
< title > Swagger & Openapi (WIP) · GitBook< / title >
2018-02-02 12:49:20 +00:00
< meta http-equiv = "X-UA-Compatible" content = "IE=edge" / >
< meta name = "description" content = "" >
< meta name = "generator" content = "GitBook 3.2.3" >
< link rel = "stylesheet" href = "gitbook/style.css" >
< link rel = "stylesheet" href = "gitbook/gitbook-plugin-highlight/website.css" >
< link rel = "stylesheet" href = "gitbook/gitbook-plugin-search/search.css" >
< link rel = "stylesheet" href = "gitbook/gitbook-plugin-fontsettings/website.css" >
< meta name = "HandheldFriendly" content = "true" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1, user-scalable=no" >
< meta name = "apple-mobile-web-app-capable" content = "yes" >
< meta name = "apple-mobile-web-app-status-bar-style" content = "black" >
< link rel = "apple-touch-icon-precomposed" sizes = "152x152" href = "gitbook/images/apple-touch-icon-precomposed-152.png" >
< link rel = "shortcut icon" href = "gitbook/images/favicon.ico" type = "image/x-icon" >
2018-02-11 19:36:11 +00:00
< link rel = "next" href = "faq.html" / >
2018-02-02 12:49:20 +00:00
< link rel = "prev" href = "interceptors.html" / >
< / head >
< body >
< div class = "book" >
< div class = "book-summary" >
< div id = "book-search-input" role = "search" >
< input type = "text" placeholder = "Type to search" / >
< / div >
< nav role = "navigation" >
< ul class = "summary" >
< li class = "chapter " data-level = "1.1" data-path = "./" >
< a href = "./" >
Introduction
< / a >
< / li >
< li class = "chapter " data-level = "1.2" data-path = "basics/" >
< a href = "basics/" >
Basics
< / a >
< ul class = "articles" >
< li class = "chapter " data-level = "1.2.1" data-path = "basics/route_syntax.html" >
< a href = "basics/route_syntax.html" >
Route Syntax
< / a >
< / li >
< li class = "chapter " data-level = "1.2.2" data-path = "basics/router.html" >
< a href = "basics/router.html" >
Router
< / a >
< / li >
< li class = "chapter " data-level = "1.2.3" data-path = "basics/path_based_routing.html" >
< a href = "basics/path_based_routing.html" >
Path-based Routing
< / a >
< / li >
< li class = "chapter " data-level = "1.2.4" data-path = "basics/name_based_routing.html" >
< a href = "basics/name_based_routing.html" >
Name-based Routing
< / a >
< / li >
< li class = "chapter " data-level = "1.2.5" data-path = "basics/route_data.html" >
< a href = "basics/route_data.html" >
Route Data
< / a >
< / li >
< li class = "chapter " data-level = "1.2.6" data-path = "basics/route_data_validation.html" >
< a href = "basics/route_data_validation.html" >
Route Data Validation
< / a >
< / li >
< li class = "chapter " data-level = "1.2.7" data-path = "basics/route_conflicts.html" >
< a href = "basics/route_conflicts.html" >
Route Conflicts
< / a >
< / li >
< / ul >
< / li >
< li class = "chapter " data-level = "1.3" data-path = "coercion/" >
< a href = "coercion/" >
Coercion
< / a >
< ul class = "articles" >
< li class = "chapter " data-level = "1.3.1" data-path = "coercion/coercion.html" >
< a href = "coercion/coercion.html" >
Coercion Explained
< / a >
< / li >
< li class = "chapter " data-level = "1.3.2" data-path = "coercion/schema_coercion.html" >
< a href = "coercion/schema_coercion.html" >
Plumatic Schema
< / a >
< / li >
< li class = "chapter " data-level = "1.3.3" data-path = "coercion/clojure_spec_coercion.html" >
< a href = "coercion/clojure_spec_coercion.html" >
Clojure.spec
< / a >
< / li >
< li class = "chapter " data-level = "1.3.4" data-path = "coercion/data_spec_coercion.html" >
< a href = "coercion/data_spec_coercion.html" >
Data-specs
< / a >
< / li >
< / ul >
< / li >
< li class = "chapter " data-level = "1.4" data-path = "advanced/" >
< a href = "advanced/" >
Advanced
< / a >
< ul class = "articles" >
< li class = "chapter " data-level = "1.4.1" data-path = "advanced/configuring_routers.html" >
< a href = "advanced/configuring_routers.html" >
Configuring Routers
< / a >
< / li >
< li class = "chapter " data-level = "1.4.2" data-path = "advanced/different_routers.html" >
< a href = "advanced/different_routers.html" >
Different Routers
< / a >
< / li >
< li class = "chapter " data-level = "1.4.3" data-path = "advanced/route_validation.html" >
< a href = "advanced/route_validation.html" >
Route Validation
< / a >
< / li >
< / ul >
< / li >
< li class = "chapter " data-level = "1.5" data-path = "ring/" >
< a href = "ring/" >
Ring
< / a >
< ul class = "articles" >
< li class = "chapter " data-level = "1.5.1" data-path = "ring/ring.html" >
< a href = "ring/ring.html" >
Ring-router
< / a >
< / li >
< li class = "chapter " data-level = "1.5.2" data-path = "ring/dynamic_extensions.html" >
< a href = "ring/dynamic_extensions.html" >
Dynamic Extensions
< / a >
< / li >
< li class = "chapter " data-level = "1.5.3" data-path = "ring/data_driven_middleware.html" >
< a href = "ring/data_driven_middleware.html" >
Data-driven Middleware
< / a >
< / li >
< li class = "chapter " data-level = "1.5.4" data-path = "ring/coercion.html" >
< a href = "ring/coercion.html" >
Pluggable Coercion
< / a >
< / li >
< li class = "chapter " data-level = "1.5.5" data-path = "ring/route_data_validation.html" >
< a href = "ring/route_data_validation.html" >
Route Data Validation
< / a >
< / li >
< li class = "chapter " data-level = "1.5.6" data-path = "ring/compiling_middleware.html" >
< a href = "ring/compiling_middleware.html" >
Compiling Middleware
< / a >
< / li >
< / ul >
< / li >
2018-02-11 19:36:11 +00:00
< li class = "chapter " data-level = "1.6" data-path = "performance.html" >
2018-02-02 12:49:20 +00:00
2018-02-11 19:36:11 +00:00
< a href = "performance.html" >
2018-02-02 12:49:20 +00:00
2018-02-11 19:36:11 +00:00
Performance
2018-02-02 12:49:20 +00:00
< / a >
< / li >
2018-02-11 19:36:11 +00:00
< li class = "chapter " data-level = "1.7" data-path = "interceptors.html" >
2018-02-02 12:49:20 +00:00
2018-02-11 19:36:11 +00:00
< a href = "interceptors.html" >
2018-02-02 12:49:20 +00:00
2018-02-11 19:36:11 +00:00
Interceptors (WIP)
2018-02-02 12:49:20 +00:00
< / a >
< / li >
2018-02-11 19:36:11 +00:00
< li class = "chapter active" data-level = "1.8" data-path = "openapi.html" >
2018-02-02 12:49:20 +00:00
2018-02-11 19:36:11 +00:00
< a href = "openapi.html" >
2018-02-02 12:49:20 +00:00
2018-02-11 19:36:11 +00:00
Swagger & Openapi (WIP)
2018-02-02 12:49:20 +00:00
< / a >
< / li >
< li class = "chapter " data-level = "1.9" data-path = "faq.html" >
< a href = "faq.html" >
FAQ
< / a >
< / li >
< li class = "divider" > < / li >
< li >
< a href = "https://www.gitbook.com" target = "blank" class = "gitbook-link" >
Published with GitBook
< / a >
< / li >
< / ul >
< / nav >
< / div >
< div class = "book-body" >
< div class = "body-inner" >
< div class = "book-header" role = "navigation" >
<!-- Title -->
< h1 >
< i class = "fa fa-circle-o-notch fa-spin" > < / i >
2018-02-11 19:36:11 +00:00
< a href = "." > Swagger & Openapi (WIP)< / a >
2018-02-02 12:49:20 +00:00
< / h1 >
< / div >
< div class = "page-wrapper" tabindex = "-1" role = "main" >
< div class = "page-inner" >
< div id = "book-search-results" >
< div class = "search-noresults" >
< section class = "normal markdown-section" >
2018-02-11 19:36:11 +00:00
< h1 id = "swagger--openapi-wip" > Swagger & OpenAPI (WIP)< / h1 >
< p > Goal is to support both < a href = "https://swagger.io/" target = "_blank" > Swagger< / a > & < a href = "https://www.openapis.org/" target = "_blank" > OpenAPI< / a > for route documentation. Documentation is extracted from existing coercion definitions < code > :parameters< / code > , < code > :responses< / code > and from a set of new doumentation keys.< / p >
< p > Swagger-support draft works, but only for Clojure.< / p >
< h3 id = "todo" > TODO< / h3 >
2018-02-02 12:49:20 +00:00
< ul >
< li > < a href = "https://github.com/metosin/schema-tools/issues/38" target = "_blank" > metosin/schema-tools#38< / a > : extract Schema-swagger from < a href = "https://github.com/metosin/ring-swagger" target = "_blank" > ring-swagger< / a > into < a href = "https://github.com/metosin/schema-tools" target = "_blank" > schema-tools< / a > to support both Clojure & ClojureScript< / li >
< li > separate modules for the swagger2 & openapi< / li >
2018-02-11 19:36:11 +00:00
< li > < a href = "https://github.com/metosin/spec-tools/issues/105" target = "_blank" > metosin/spec-tools#105< / a > : support Openapi< / li >
2018-02-02 12:49:20 +00:00
< / ul >
2018-02-11 19:36:11 +00:00
< h3 id = "example" > Example< / h3 >
< p > Current < code > reitit-swagger< / code > draft (with < code > reitit-ring< / code > & data-specs):< / p >
< pre > < code class = "lang-clj" > (< span class = "hljs-name" > require< / span > ' [reitit.ring < span class = "hljs-symbol" > :as< / span > ring])
(< span class = "hljs-name" > require< / span > ' [reitit.ring.swagger < span class = "hljs-symbol" > :as< / span > swagger])
(< span class = "hljs-name" > require< / span > ' [reitit.ring.coercion < span class = "hljs-symbol" > :as< / span > rrc])
(< span class = "hljs-name" > require< / span > ' [reitit.coercion.spec < span class = "hljs-symbol" > :as< / span > spec])
(< span class = "hljs-name" > < span class = "hljs-builtin-name" > def< / span > < / span > app
(< span class = "hljs-name" > ring/ring-handler< / span >
(< span class = "hljs-name" > ring/router< / span >
[< span class = "hljs-string" > " /api" < / span >
< span class = "hljs-comment" > ;; identify a swagger api< / span >
< span class = "hljs-comment" > ;; there can be several in a routing tree< / span >
{< span class = "hljs-symbol" > :swagger< / span > {< span class = "hljs-symbol" > :id< / span > < span class = "hljs-symbol" > :math< / span > }}
< span class = "hljs-comment" > ;; the (undocumented) swagger spec endpoint< / span >
[< span class = "hljs-string" > " /swagger.json" < / span >
{< span class = "hljs-symbol" > :get< / span > {< span class = "hljs-symbol" > :no-doc< / span > < span class = "hljs-literal" > true< / span >
< span class = "hljs-symbol" > :swagger< / span > {< span class = "hljs-symbol" > :info< / span > {< span class = "hljs-symbol" > :title< / span > < span class = "hljs-string" > " my-api" < / span > }}
< span class = "hljs-symbol" > :handler< / span > swagger/swagger-spec-handler}}]
[< span class = "hljs-string" > " /minus" < / span >
{< span class = "hljs-symbol" > :get< / span > {< span class = "hljs-symbol" > :summary< / span > < span class = "hljs-string" > " minus" < / span >
< span class = "hljs-symbol" > :parameters< / span > {< span class = "hljs-symbol" > :query< / span > {< span class = "hljs-symbol" > :x< / span > int?, < span class = "hljs-symbol" > :y< / span > int?}}
< span class = "hljs-symbol" > :responses< / span > {< span class = "hljs-number" > 200< / span > {< span class = "hljs-symbol" > :body< / span > {< span class = "hljs-symbol" > :total< / span > int?}}}
< span class = "hljs-symbol" > :handler< / span > (< span class = "hljs-name" > < span class = "hljs-builtin-name" > fn< / span > < / span > [{{{< span class = "hljs-symbol" > :keys< / span > [x y]} < span class = "hljs-symbol" > :query< / span > } < span class = "hljs-symbol" > :parameters< / span > }]
{< span class = "hljs-symbol" > :status< / span > < span class = "hljs-number" > 200< / span > , < span class = "hljs-symbol" > :body< / span > {< span class = "hljs-symbol" > :total< / span > (< span class = "hljs-name" > < span class = "hljs-builtin-name" > -< / span > < / span > x y)}})}}]
[< span class = "hljs-string" > " /plus" < / span >
{< span class = "hljs-symbol" > :get< / span > {< span class = "hljs-symbol" > :summary< / span > < span class = "hljs-string" > " plus" < / span >
< span class = "hljs-symbol" > :parameters< / span > {< span class = "hljs-symbol" > :query< / span > {< span class = "hljs-symbol" > :x< / span > int?, < span class = "hljs-symbol" > :y< / span > int?}}
< span class = "hljs-symbol" > :responses< / span > {< span class = "hljs-number" > 200< / span > {< span class = "hljs-symbol" > :body< / span > {< span class = "hljs-symbol" > :total< / span > int?}}}
< span class = "hljs-symbol" > :handler< / span > (< span class = "hljs-name" > < span class = "hljs-builtin-name" > fn< / span > < / span > [{{{< span class = "hljs-symbol" > :keys< / span > [x y]} < span class = "hljs-symbol" > :query< / span > } < span class = "hljs-symbol" > :parameters< / span > }]
{< span class = "hljs-symbol" > :status< / span > < span class = "hljs-number" > 200< / span > , < span class = "hljs-symbol" > :body< / span > {< span class = "hljs-symbol" > :total< / span > (< span class = "hljs-name" > < span class = "hljs-builtin-name" > +< / span > < / span > x y)}})}}]]
{< span class = "hljs-symbol" > :data< / span > {< span class = "hljs-symbol" > :middleware< / span > [< span class = "hljs-comment" > ;; does not particiate in request processing< / span >
< span class = "hljs-comment" > ;; just defines specs for the extra keys< / span >
swagger/swagger-middleware
rrc/coerce-exceptions-middleware
rrc/coerce-request-middleware
rrc/coerce-response-middleware]
< span class = "hljs-symbol" > :coercion< / span > spec/coercion}})))
< / code > < / pre >
2018-02-02 12:49:20 +00:00
< / section >
< / div >
< div class = "search-results" >
< div class = "has-results" >
< h1 class = "search-results-title" > < span class = 'search-results-count' > < / span > results matching "< span class = 'search-query' > < / span > "< / h1 >
< ul class = "search-results-list" > < / ul >
< / div >
< div class = "no-results" >
< h1 class = "search-results-title" > No results matching "< span class = 'search-query' > < / span > "< / h1 >
< / div >
< / div >
< / div >
< / div >
< / div >
< / div >
2018-02-11 19:36:11 +00:00
< a href = "interceptors.html" class = "navigation navigation-prev " aria-label = "Previous page: Interceptors (WIP)" >
2018-02-02 12:49:20 +00:00
< i class = "fa fa-angle-left" > < / i >
< / a >
2018-02-11 19:36:11 +00:00
< a href = "faq.html" class = "navigation navigation-next " aria-label = "Next page: FAQ" >
2018-02-02 12:49:20 +00:00
< i class = "fa fa-angle-right" > < / i >
< / a >
< / div >
< script >
var gitbook = gitbook || [];
gitbook.push(function() {
2018-03-15 06:06:13 +00:00
gitbook.page.hasChanged({"page":{"title":"Swagger & Openapi (WIP)","level":"1.8","depth":1,"next":{"title":"FAQ","level":"1.9","depth":1,"path":"faq.md","ref":"faq.md","articles":[]},"previous":{"title":"Interceptors (WIP)","level":"1.7","depth":1,"path":"interceptors.md","ref":"interceptors.md","articles":[]},"dir":"ltr"},"config":{"plugins":["editlink","github","highlight"],"root":"doc","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"editlink":{"label":"Edit This Page","multilingual":false,"base":"https://github.com/metosin/reitit/tree/master/doc"},"github":{"url":"https://github.com/metosin/reitit"},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"gitbook":"*"},"file":{"path":"openapi.md","mtime":"2018-03-15T06:05:23.554Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-03-15T06:06:08.806Z"},"basePath":".","book":{"language":""}});
2018-02-02 12:49:20 +00:00
});
< / script >
< / div >
< script src = "gitbook/gitbook.js" > < / script >
< script src = "gitbook/theme.js" > < / script >
< script src = "gitbook/gitbook-plugin-editlink/plugin.js" > < / script >
< script src = "gitbook/gitbook-plugin-github/plugin.js" > < / script >
< script src = "gitbook/gitbook-plugin-search/search-engine.js" > < / script >
< script src = "gitbook/gitbook-plugin-search/search.js" > < / script >
< script src = "gitbook/gitbook-plugin-lunr/lunr.min.js" > < / script >
< script src = "gitbook/gitbook-plugin-lunr/search-lunr.js" > < / script >
< script src = "gitbook/gitbook-plugin-sharing/buttons.js" > < / script >
< script src = "gitbook/gitbook-plugin-fontsettings/fontsettings.js" > < / script >
< / body >
< / html >
