2018-05-14 13:54:28 +00:00
<!DOCTYPE HTML>
< html lang = "" >
< head >
< meta charset = "UTF-8" >
< meta content = "text/html; charset=utf-8" http-equiv = "Content-Type" >
< title > Swagger Support · GitBook< / title >
< 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" >
2018-09-03 15:58:24 +00:00
< link rel = "stylesheet" href = "../gitbook/gitbook-plugin-hints/plugin-hints.css" >
2018-05-14 13:54:28 +00:00
< 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" >
2019-01-30 14:34:15 +00:00
< link rel = "next" href = "RESTful_form_methods.html" / >
2018-05-14 13:54:28 +00:00
< link rel = "prev" href = "compiling_middleware.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" >
2018-09-03 15:58:24 +00:00
< li class = "header" > Introduction< / li >
2018-05-14 13:54:28 +00:00
< li class = "chapter " data-level = "1.1" data-path = "../" >
< a href = "../" >
Introduction
< / a >
< / li >
2018-09-03 15:58:24 +00:00
< li class = "header" > Basics< / li >
< li class = "chapter " data-level = "2.1" data-path = "../basics/route_syntax.html" >
2018-05-14 13:54:28 +00:00
< a href = "../basics/route_syntax.html" >
Route Syntax
< / a >
< / li >
2018-09-03 15:58:24 +00:00
< li class = "chapter " data-level = "2.2" data-path = "../basics/router.html" >
2018-05-14 13:54:28 +00:00
< a href = "../basics/router.html" >
Router
< / a >
< / li >
2018-09-03 15:58:24 +00:00
< li class = "chapter " data-level = "2.3" data-path = "../basics/path_based_routing.html" >
2018-05-14 13:54:28 +00:00
< a href = "../basics/path_based_routing.html" >
Path-based Routing
< / a >
< / li >
2018-09-03 15:58:24 +00:00
< li class = "chapter " data-level = "2.4" data-path = "../basics/name_based_routing.html" >
2018-05-14 13:54:28 +00:00
< a href = "../basics/name_based_routing.html" >
Name-based Routing
< / a >
< / li >
2018-09-03 15:58:24 +00:00
< li class = "chapter " data-level = "2.5" data-path = "../basics/route_data.html" >
2018-05-14 13:54:28 +00:00
< a href = "../basics/route_data.html" >
Route Data
< / a >
< / li >
2018-09-03 15:58:24 +00:00
< li class = "chapter " data-level = "2.6" data-path = "../basics/route_data_validation.html" >
2018-05-14 13:54:28 +00:00
< a href = "../basics/route_data_validation.html" >
Route Data Validation
< / a >
< / li >
2018-09-03 15:58:24 +00:00
< li class = "chapter " data-level = "2.7" data-path = "../basics/route_conflicts.html" >
2018-05-14 13:54:28 +00:00
< a href = "../basics/route_conflicts.html" >
Route Conflicts
< / a >
2019-05-12 18:16:46 +00:00
< / li >
< li class = "chapter " data-level = "2.8" data-path = "../basics/error_messages.html" >
< a href = "../basics/error_messages.html" >
Error Messages
< / a >
2018-05-14 13:54:28 +00:00
< / li >
2018-09-03 15:58:24 +00:00
< li class = "header" > Coercion< / li >
2018-05-14 13:54:28 +00:00
2018-09-03 15:58:24 +00:00
< li class = "chapter " data-level = "3.1" data-path = "../coercion/coercion.html" >
2018-05-14 13:54:28 +00:00
< a href = "../coercion/coercion.html" >
Coercion Explained
< / a >
< / li >
2018-09-03 15:58:24 +00:00
< li class = "chapter " data-level = "3.2" data-path = "../coercion/schema_coercion.html" >
2018-05-14 13:54:28 +00:00
< a href = "../coercion/schema_coercion.html" >
Plumatic Schema
< / a >
< / li >
2018-09-03 15:58:24 +00:00
< li class = "chapter " data-level = "3.3" data-path = "../coercion/clojure_spec_coercion.html" >
2018-05-14 13:54:28 +00:00
< a href = "../coercion/clojure_spec_coercion.html" >
Clojure.spec
< / a >
< / li >
2018-09-03 15:58:24 +00:00
< li class = "chapter " data-level = "3.4" data-path = "../coercion/data_spec_coercion.html" >
2018-05-14 13:54:28 +00:00
< a href = "../coercion/data_spec_coercion.html" >
Data-specs
< / a >
< / li >
2018-09-03 15:58:24 +00:00
< li class = "header" > Ring< / li >
2018-05-14 13:54:28 +00:00
2018-09-03 15:58:24 +00:00
< li class = "chapter " data-level = "4.1" data-path = "ring.html" >
2018-05-14 13:54:28 +00:00
2018-08-25 12:49:36 +00:00
< a href = "ring.html" >
2018-05-14 13:54:28 +00:00
2018-08-25 12:49:36 +00:00
Ring-router
2018-05-14 13:54:28 +00:00
< / a >
< / li >
2018-09-03 15:58:24 +00:00
< li class = "chapter " data-level = "4.2" data-path = "reverse_routing.html" >
2018-07-18 10:13:28 +00:00
2018-08-25 12:49:36 +00:00
< a href = "reverse_routing.html" >
2018-07-18 10:13:28 +00:00
2018-08-25 12:49:36 +00:00
Reverse-routing
2018-07-18 10:13:28 +00:00
< / a >
< / li >
2018-09-03 15:58:24 +00:00
< li class = "chapter " data-level = "4.3" data-path = "default_handler.html" >
2018-05-14 13:54:28 +00:00
2018-08-25 12:49:36 +00:00
< a href = "default_handler.html" >
2018-05-14 13:54:28 +00:00
2018-08-25 12:49:36 +00:00
Default handler
2018-05-14 13:54:28 +00:00
< / a >
< / li >
2018-10-30 17:54:38 +00:00
< li class = "chapter " data-level = "4.4" data-path = "slash_handler.html" >
< a href = "slash_handler.html" >
Slash handler
< / a >
< / li >
< li class = "chapter " data-level = "4.5" data-path = "static.html" >
2018-05-14 13:54:28 +00:00
2018-08-25 12:49:36 +00:00
< a href = "static.html" >
2018-05-14 13:54:28 +00:00
2018-08-25 12:49:36 +00:00
Static Resources
2018-05-14 13:54:28 +00:00
< / a >
< / li >
2018-10-30 17:54:38 +00:00
< li class = "chapter " data-level = "4.6" data-path = "dynamic_extensions.html" >
2018-05-14 13:54:28 +00:00
2018-08-25 12:49:36 +00:00
< a href = "dynamic_extensions.html" >
2018-05-14 13:54:28 +00:00
2018-08-25 12:49:36 +00:00
Dynamic Extensions
2018-05-14 13:54:28 +00:00
< / a >
< / li >
2018-10-30 17:54:38 +00:00
< li class = "chapter " data-level = "4.7" data-path = "data_driven_middleware.html" >
2018-08-25 12:49:36 +00:00
< a href = "data_driven_middleware.html" >
Data-driven Middleware
< / a >
2018-05-14 13:54:28 +00:00
< / li >
2018-10-30 17:54:38 +00:00
< li class = "chapter " data-level = "4.8" data-path = "transforming_middleware_chain.html" >
2018-05-14 13:54:28 +00:00
2018-08-25 12:49:36 +00:00
< a href = "transforming_middleware_chain.html" >
2018-05-14 13:54:28 +00:00
2018-08-25 12:49:36 +00:00
Transforming Middleware Chain
2018-05-14 13:54:28 +00:00
< / a >
2018-08-25 12:49:36 +00:00
< / li >
2018-05-14 13:54:28 +00:00
2018-10-30 17:54:38 +00:00
< li class = "chapter " data-level = "4.9" data-path = "middleware_registry.html" >
2018-05-14 13:54:28 +00:00
2018-08-25 12:49:36 +00:00
< a href = "middleware_registry.html" >
2018-05-14 13:54:28 +00:00
2018-08-25 12:49:36 +00:00
Middleware Registry
2018-05-14 13:54:28 +00:00
< / a >
< / li >
2018-10-30 17:54:38 +00:00
< li class = "chapter " data-level = "4.10" data-path = "default_middleware.html" >
2018-06-14 10:29:02 +00:00
2018-08-25 12:49:36 +00:00
< a href = "default_middleware.html" >
2018-06-14 10:29:02 +00:00
2018-08-25 12:49:36 +00:00
Default Middleware
2018-06-14 10:29:02 +00:00
< / a >
< / li >
2018-10-30 17:54:38 +00:00
< li class = "chapter " data-level = "4.11" data-path = "coercion.html" >
2018-05-14 13:54:28 +00:00
2018-08-25 12:49:36 +00:00
< a href = "coercion.html" >
2018-05-14 13:54:28 +00:00
2019-02-20 06:29:04 +00:00
Ring Coercion
2018-05-14 13:54:28 +00:00
< / a >
< / li >
2018-10-30 17:54:38 +00:00
< li class = "chapter " data-level = "4.12" data-path = "route_data_validation.html" >
2018-05-14 13:54:28 +00:00
2018-08-25 12:49:36 +00:00
< a href = "route_data_validation.html" >
2018-05-14 13:54:28 +00:00
2018-08-25 12:49:36 +00:00
Route Data Validation
2018-05-14 13:54:28 +00:00
< / a >
< / li >
2018-10-30 17:54:38 +00:00
< li class = "chapter " data-level = "4.13" data-path = "compiling_middleware.html" >
2018-05-14 13:54:28 +00:00
2018-08-25 12:49:36 +00:00
< a href = "compiling_middleware.html" >
2018-05-14 13:54:28 +00:00
2018-08-25 12:49:36 +00:00
Compiling Middleware
2018-05-14 13:54:28 +00:00
< / a >
< / li >
2018-10-30 17:54:38 +00:00
< li class = "chapter active" data-level = "4.14" data-path = "swagger.html" >
2018-05-14 13:54:28 +00:00
2018-08-25 12:49:36 +00:00
< a href = "swagger.html" >
2018-05-14 13:54:28 +00:00
2018-08-25 12:49:36 +00:00
Swagger Support
2018-05-14 13:54:28 +00:00
< / a >
2019-01-30 14:32:00 +00:00
< / li >
2019-01-30 14:34:15 +00:00
< li class = "chapter " data-level = "4.15" data-path = "RESTful_form_methods.html" >
2019-01-30 14:32:00 +00:00
2019-01-30 14:34:15 +00:00
< a href = "RESTful_form_methods.html" >
2019-01-30 14:32:00 +00:00
RESTful form methods
< / a >
2018-05-14 13:54:28 +00:00
< / li >
2018-08-25 12:49:36 +00:00
2018-09-03 15:58:24 +00:00
2018-09-08 07:54:15 +00:00
< li class = "header" > HTTP< / li >
2018-09-03 15:58:24 +00:00
2018-08-22 18:52:18 +00:00
2018-09-08 07:54:15 +00:00
< li class = "chapter " data-level = "5.1" data-path = "../http/interceptors.html" >
2018-07-28 09:08:17 +00:00
2018-09-08 07:54:15 +00:00
< a href = "../http/interceptors.html" >
2018-07-28 09:08:17 +00:00
2018-09-08 07:54:15 +00:00
Interceptors
2018-07-28 09:08:17 +00:00
< / a >
< / li >
2018-09-08 07:54:15 +00:00
< li class = "chapter " data-level = "5.2" data-path = "../http/pedestal.html" >
2018-08-03 07:10:16 +00:00
2018-09-08 07:54:15 +00:00
< a href = "../http/pedestal.html" >
2018-08-03 07:10:16 +00:00
2018-09-08 07:54:15 +00:00
Pedestal
2018-08-03 07:10:16 +00:00
< / a >
< / li >
2018-09-08 07:54:15 +00:00
< li class = "chapter " data-level = "5.3" data-path = "../http/sieppari.html" >
2018-05-14 13:54:28 +00:00
2018-09-08 07:54:15 +00:00
< a href = "../http/sieppari.html" >
Sieppari
< / a >
< / li >
< li class = "chapter " data-level = "5.4" data-path = "../http/default_interceptors.html" >
< a href = "../http/default_interceptors.html" >
2018-05-14 13:54:28 +00:00
2018-09-08 07:54:15 +00:00
Default Interceptors
2018-05-14 13:54:28 +00:00
< / a >
2018-12-30 15:16:28 +00:00
< / li >
< li class = "chapter " data-level = "5.5" data-path = "../http/transforming_interceptor_chain.html" >
< a href = "../http/transforming_interceptor_chain.html" >
Transforming Interceptor Chain
< / a >
2018-05-14 13:54:28 +00:00
< / li >
2018-09-03 15:58:24 +00:00
2018-09-08 07:54:15 +00:00
< li class = "header" > Frontend< / li >
2018-09-03 15:58:24 +00:00
2018-09-08 07:54:15 +00:00
< li class = "chapter " data-level = "6.1" data-path = "../frontend/basics.html" >
2018-05-14 13:54:28 +00:00
2018-09-08 07:54:15 +00:00
< a href = "../frontend/basics.html" >
2018-05-14 13:54:28 +00:00
2018-09-08 07:54:15 +00:00
Basics
< / a >
< / li >
< li class = "chapter " data-level = "6.2" data-path = "../frontend/browser.html" >
< a href = "../frontend/browser.html" >
Browser integration
< / a >
< / li >
< li class = "chapter " data-level = "6.3" data-path = "../frontend/controllers.html" >
< a href = "../frontend/controllers.html" >
Controllers
2018-05-14 13:54:28 +00:00
< / a >
< / li >
2018-08-25 12:49:36 +00:00
2018-09-03 15:58:24 +00:00
< li class = "header" > Advanced< / li >
< li class = "chapter " data-level = "7.1" data-path = "../advanced/configuring_routers.html" >
2018-08-25 12:49:36 +00:00
2018-09-03 15:58:24 +00:00
< a href = "../advanced/configuring_routers.html" >
2018-05-14 13:54:28 +00:00
2018-09-03 15:58:24 +00:00
Configuring Routers
2018-08-25 12:49:36 +00:00
< / a >
2018-09-03 15:58:24 +00:00
< / li >
2018-08-25 12:49:36 +00:00
2018-09-03 15:58:24 +00:00
< li class = "chapter " data-level = "7.2" data-path = "../advanced/composing_routers.html" >
2018-08-25 12:49:36 +00:00
2018-09-03 15:58:24 +00:00
< a href = "../advanced/composing_routers.html" >
2018-08-25 12:49:36 +00:00
2018-09-03 15:58:24 +00:00
Composing Routers
2018-05-14 13:54:28 +00:00
< / a >
< / li >
2018-09-03 15:58:24 +00:00
< li class = "chapter " data-level = "7.3" data-path = "../advanced/different_routers.html" >
2018-05-14 13:54:28 +00:00
2018-09-03 15:58:24 +00:00
< a href = "../advanced/different_routers.html" >
2018-07-18 10:13:28 +00:00
2018-09-03 15:58:24 +00:00
Different Routers
2018-07-18 10:13:28 +00:00
< / a >
2018-09-03 15:58:24 +00:00
< / li >
2018-07-18 10:13:28 +00:00
2018-09-03 15:58:24 +00:00
< li class = "chapter " data-level = "7.4" data-path = "../advanced/route_validation.html" >
2018-07-18 10:13:28 +00:00
2018-09-03 15:58:24 +00:00
< a href = "../advanced/route_validation.html" >
2018-07-18 10:13:28 +00:00
2018-09-03 15:58:24 +00:00
Route Validation
2018-07-18 10:13:28 +00:00
< / a >
< / li >
2018-09-03 15:58:24 +00:00
< li class = "chapter " data-level = "7.5" data-path = "../advanced/dev_workflow.html" >
2018-07-18 10:13:28 +00:00
2018-09-03 15:58:24 +00:00
< a href = "../advanced/dev_workflow.html" >
2018-07-18 10:13:28 +00:00
2018-09-03 15:58:24 +00:00
Dev Workflow
2018-07-18 10:13:28 +00:00
< / a >
< / li >
2018-09-03 15:58:24 +00:00
< li class = "chapter " data-level = "7.6" data-path = "../advanced/shared_routes.html" >
2018-07-18 10:13:28 +00:00
2018-09-03 15:58:24 +00:00
< a href = "../advanced/shared_routes.html" >
2018-07-18 10:13:28 +00:00
2018-09-03 15:58:24 +00:00
Shared Routes
2018-07-18 10:13:28 +00:00
< / a >
< / li >
2018-09-03 15:58:24 +00:00
< li class = "header" > Misc< / li >
< li class = "chapter " data-level = "8.1" data-path = "../performance.html" >
2018-05-14 13:54:28 +00:00
< a href = "../performance.html" >
Performance
< / a >
< / li >
2018-09-03 15:58:24 +00:00
< li class = "chapter " data-level = "8.2" data-path = "../development.html" >
2018-05-20 16:52:28 +00:00
< a href = "../development.html" >
Development Instructions
< / a >
< / li >
2018-09-03 15:58:24 +00:00
< li class = "chapter " data-level = "8.3" data-path = "../faq.html" >
2018-05-14 13:54:28 +00:00
< 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 >
< a href = ".." > Swagger Support< / a >
< / 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" >
< h1 id = "swagger-support" > Swagger Support< / h1 >
2019-05-22 19:17:48 +00:00
< pre > < code > [metosin/reitit-swagger " 0.3.5" ]
2018-05-14 13:54:28 +00:00
< / code > < / pre > < p > Reitit supports < a href = "https://swagger.io/" target = "_blank" > Swagger2< / a > documentation, thanks to < a href = "https://github.com/metosin/schema-tools" target = "_blank" > schema-tools< / a > and < a href = "https://github.com/metosin/spec-tools" target = "_blank" > spec-tools< / a > . Documentation is extracted from route definitions, coercion < code > :parameters< / code > and < code > :responses< / code > and from a set of new documentation keys.< / p >
< p > To enable swagger-documentation for a ring-router:< / p >
< ol >
2019-01-27 20:51:05 +00:00
< li > annotate your routes with swagger-data< / li >
2018-05-14 13:54:28 +00:00
< li > mount a swagger-handler to serve the swagger-spec< / li >
< li > optionally mount a swagger-ui to visualize the swagger-spec< / li >
< / ol >
< h2 id = "swagger-data" > Swagger data< / h2 >
< p > The following route data keys contribute to the generated swagger specification:< / p >
< table >
< thead >
< tr >
< th > key< / th >
< th > description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > :swagger< / td >
2018-07-21 06:48:05 +00:00
< td > map of any swagger-data. Can have < code > :id< / code > (keyword or sequence of keywords) to identify the api< / td >
2018-05-14 13:54:28 +00:00
< / tr >
< tr >
< td > :no-doc< / td >
< td > optional boolean to exclude endpoint from api docs< / td >
< / tr >
< tr >
< td > :tags< / td >
< td > optional set of strings of keywords tags for an endpoint api docs< / td >
< / tr >
< tr >
< td > :summary< / td >
< td > optional short string summary of an endpoint< / td >
< / tr >
< tr >
< td > :description< / td >
< td > optional long description of an endpoint. Supports < a href = "http://spec.commonmark.org/" target = "_blank" > http://spec.commonmark.org/< / a > < / td >
< / tr >
< / tbody >
< / table >
< p > Coercion keys also contribute to the docs:< / p >
< table >
< thead >
< tr >
< th > key< / th >
< th > description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > :parameters< / td >
< td > optional input parameters for a route, in a format defined by the coercion< / td >
< / tr >
< tr >
< td > :responses< / td >
< td > optional descriptions of responess, in a format defined by coercion< / td >
< / tr >
< / tbody >
< / table >
< p > There is a < code > reitit.swagger.swagger-feature< / code > , which acts as both a < code > Middleware< / code > and an < code > Interceptor< / code > that is not participating in any request processing - it just defines the route data specs for the routes it' s mounted to. It is only needed if the < a href = "route_data_validation.html" > route data validation< / a > is turned on.< / p >
< h2 id = "swagger-spec" > Swagger spec< / h2 >
2018-06-13 06:28:25 +00:00
< p > To serve the actual < a href = "https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md" target = "_blank" > Swagger Specification< / a > , there is < code > reitit.swagger/create-swagger-handler< / code > . It takes no arguments and returns a ring-handler which collects at request-time data from all routes for the same swagger api and returns a formatted Swagger specification as Clojure data, to be encoded by a response formatter.< / p >
2018-05-14 13:54:28 +00:00
< p > If you need to post-process the generated spec, just wrap the handler with a custom < code > Middleware< / code > or an < code > Interceptor< / code > .< / p >
< h2 id = "swagger-ui" > Swagger-ui< / h2 >
2018-06-13 06:28:25 +00:00
< p > < a href = "https://github.com/swagger-api/swagger-ui" target = "_blank" > Swagger-ui< / a > is a user interface to visualize and interact with the Swagger specification. To make things easy, there is a pre-integrated version of the swagger-ui as a separate module.< / p >
2019-05-22 19:17:48 +00:00
< pre > < code > [metosin/reitit-swagger-ui " 0.3.5" ]
2018-05-14 13:54:28 +00:00
< / code > < / pre > < p > < code > reitit.swagger-ui/create-swagger-ui-hander< / code > can be used to create a ring-handler to serve the swagger-ui. It accepts the following options:< / p >
< table >
< thead >
< tr >
< th > key< / th >
< th > description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > :parameter< / td >
< td > optional name of the wildcard parameter, defaults to unnamed keyword < code > :< / code > < / td >
< / tr >
< tr >
< td > :root< / td >
< td > optional resource root, defaults to < code > " swagger-ui" < / code > < / td >
< / tr >
< tr >
< td > :url< / td >
< td > path to swagger endpoint, defaults to < code > /swagger.json< / code > < / td >
< / tr >
< tr >
< td > :path< / td >
< td > optional path to mount the handler to. Works only if mounted outside of a router.< / td >
< / tr >
< tr >
< td > :config< / td >
2018-07-16 06:35:55 +00:00
< td > parameters passed to swaggger-ui as-is. See < a href = "https://github.com/swagger-api/swagger-ui/tree/2.x#parameters" target = "_blank" > the docs< / a > < / td >
2018-05-14 13:54:28 +00:00
< / tr >
< / tbody >
< / table >
< p > We use swagger-ui from < a href = "https://github.com/metosin/ring-swagger-ui" target = "_blank" > ring-swagger-ui< / a > , which can be easily configured from routing application. It stores files < code > swagger-ui< / code > in the resource classpath.< / p >
< p > Webjars also hosts a < a href = "https://github.com/webjars/swagger-ui" target = "_blank" > version< / a > of the swagger-ui.< / p >
< p > < strong > NOTE< / strong > : Currently, swagger-ui module is just for Clojure. ClojureScript-support welcome as a PR!< / p >
< h2 id = "examples" > Examples< / h2 >
< h3 id = "simple-example" > Simple example< / h3 >
< ul >
2018-07-21 06:48:05 +00:00
< li > two routes< / li >
2018-05-14 13:54:28 +00:00
< li > swagger-spec served from < code > " /swagger.json" < / code > < / li >
2018-12-09 18:17:19 +00:00
< li > swagger-ui mounted to < code > " /api-docs" < / code > < / li >
2018-11-22 08:36:49 +00:00
< li > note that for real-world use, you need a < a href = "default_middleware.html#content-negotiation" > content-negation middleware< / a > -
see the next example< / li >
2018-05-14 13:54:28 +00:00
< / ul >
< 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.swagger < span class = "hljs-symbol" > :as< / span > swagger])
(< span class = "hljs-name" > require< / span > ' [reitit.swagger-ui < span class = "hljs-symbol" > :as< / span > swagger-ui])
(< 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 >
2018-07-21 07:03:29 +00:00
[< span class = "hljs-string" > " /ping" < / span > {< span class = "hljs-symbol" > :get< / span > (< span class = "hljs-name" > < span class = "hljs-builtin-name" > constantly< / span > < / span > {< span class = "hljs-symbol" > :status< / span > < span class = "hljs-number" > 200< / span > , < span class = "hljs-symbol" > :body< / span > < span class = "hljs-string" > " ping" < / span > })}]
[< span class = "hljs-string" > " /pong" < / span > {< span class = "hljs-symbol" > :post< / span > (< span class = "hljs-name" > < span class = "hljs-builtin-name" > constantly< / span > < / span > {< span class = "hljs-symbol" > :status< / span > < span class = "hljs-number" > 200< / span > , < span class = "hljs-symbol" > :body< / span > < span class = "hljs-string" > " pong" < / span > })}]]
2018-12-09 18:17:19 +00:00
[< span class = "hljs-string" > " " < / span > {< span class = "hljs-symbol" > :no-doc< / span > < span class = "hljs-literal" > true< / span > }
[< span class = "hljs-string" > " /swagger.json" < / span > {< span class = "hljs-symbol" > :get< / span > (< span class = "hljs-name" > swagger/create-swagger-handler< / span > )}]
[< span class = "hljs-string" > " /api-docs/*" < / span > {< span class = "hljs-symbol" > :get< / span > (< span class = "hljs-name" > swagger-ui/create-swagger-ui-handler< / span > )}]]])))
2018-05-14 13:54:28 +00:00
< / code > < / pre >
< p > The generated swagger spec:< / p >
< pre > < code class = "lang-clj" > (< span class = "hljs-name" > app< / span > {< span class = "hljs-symbol" > :request-method< / span > < span class = "hljs-symbol" > :get< / span > < span class = "hljs-symbol" > :uri< / span > < span class = "hljs-string" > " /swagger.json" < / span > })
< span class = "hljs-comment" > ;{:status 200< / span >
< span class = "hljs-comment" > ; :body {:swagger " 2.0" < / span >
2018-07-21 06:48:05 +00:00
< span class = "hljs-comment" > ; :x-id #{:reitit.swagger/default}< / span >
2018-05-14 13:54:28 +00:00
< span class = "hljs-comment" > ; :paths {" /api/ping" {:get {}}< / span >
< span class = "hljs-comment" > ; " /api/pong" {:post {}}}}}< / span >
< / code > < / pre >
< p > Swagger-ui:< / p >
2018-12-09 18:17:19 +00:00
< pre > < code class = "lang-clj" > (< span class = "hljs-name" > app< / span > {< span class = "hljs-symbol" > :request-method< / span > < span class = "hljs-symbol" > :get< / span > , < span class = "hljs-symbol" > :uri< / span > < span class = "hljs-string" > " /api-docs/index.html" < / span > })
2018-05-14 13:54:28 +00:00
< span class = "hljs-comment" > ; ... the swagger-ui index-page, configured correctly< / span >
< / code > < / pre >
2018-12-09 18:17:19 +00:00
< p > You might be interested in adding a < a href = "slash_handler.html" > trailing slash handler< / a > to the app to serve the swagger-ui from < code > /api-docs< / code > (without the trailing slash) too.< / p >
< p > Another way to serve the swagger-ui is using the < a href = "default_handler.html" > default handler< / a > :< / p >
< pre > < code class = "lang-clj" > (< 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-string" > " /ping" < / span > {< span class = "hljs-symbol" > :get< / span > (< span class = "hljs-name" > < span class = "hljs-builtin-name" > constantly< / span > < / span > {< span class = "hljs-symbol" > :status< / span > < span class = "hljs-number" > 200< / span > , < span class = "hljs-symbol" > :body< / span > < span class = "hljs-string" > " ping" < / span > })}]
[< span class = "hljs-string" > " /pong" < / span > {< span class = "hljs-symbol" > :post< / span > (< span class = "hljs-name" > < span class = "hljs-builtin-name" > constantly< / span > < / span > {< span class = "hljs-symbol" > :status< / span > < span class = "hljs-number" > 200< / span > , < span class = "hljs-symbol" > :body< / span > < span class = "hljs-string" > " pong" < / 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" > :handler< / span > (< span class = "hljs-name" > swagger/create-swagger-handler< / span > )}}]])
(< span class = "hljs-name" > swagger-ui/create-swagger-ui-handler< / span > {< span class = "hljs-symbol" > :path< / span > < span class = "hljs-string" > " /api-docs" < / span > })))
< / code > < / pre >
2018-05-14 13:54:28 +00:00
< h3 id = "more-complete-example" > More complete example< / h3 >
< ul >
2018-08-22 18:52:18 +00:00
< li > < code > clojure.spec< / code > coercion< / li >
2019-03-08 06:49:17 +00:00
< li > swagger data (< code > :tags< / code > , < code > :produces< / code > , < code > :summary< / code > , < code > :basePath< / code > )< / li >
2018-08-22 18:52:18 +00:00
< li > swagger-spec served from < code > " /swagger.json" < / code > < / li >
2018-05-14 13:54:28 +00:00
< li > swagger-ui mounted to < code > " /" < / code > < / li >
2018-08-22 18:52:18 +00:00
< li > set of middleware for content negotiation, exceptions, multipart etc.< / li >
2018-05-14 13:54:28 +00:00
< li > missed routes are handled by < code > create-default-handler< / code > < / li >
< li > served via < a href = "https://github.com/ring-clojure/ring/tree/master/ring-jetty-adapter" target = "_blank" > ring-jetty< / a > < / li >
< / ul >
< p > Whole example project is in < a href = "https://github.com/metosin/reitit/tree/master/examples/ring-swagger" target = "_blank" > < code > /examples/ring-swagger< / code > < / a > .< / p >
2018-08-22 18:52:18 +00:00
< pre > < code class = "lang-clj" > (< span class = "hljs-name" > < span class = "hljs-builtin-name" > ns< / span > < / span > example.server
(< span class = "hljs-symbol" > :require< / span > [reitit.ring < span class = "hljs-symbol" > :as< / span > ring]
[reitit.swagger < span class = "hljs-symbol" > :as< / span > swagger]
[reitit.swagger-ui < span class = "hljs-symbol" > :as< / span > swagger-ui]
[reitit.ring.coercion < span class = "hljs-symbol" > :as< / span > coercion]
[reitit.coercion.spec]
[reitit.ring.middleware.muuntaja < span class = "hljs-symbol" > :as< / span > muuntaja]
[reitit.ring.middleware.exception < span class = "hljs-symbol" > :as< / span > exception]
[reitit.ring.middleware.multipart < span class = "hljs-symbol" > :as< / span > multipart]
2018-09-08 07:54:15 +00:00
[reitit.ring.middleware.parameters < span class = "hljs-symbol" > :as< / span > parameters]
2018-08-22 18:52:18 +00:00
[ring.middleware.params < span class = "hljs-symbol" > :as< / span > params]
[ring.adapter.jetty < span class = "hljs-symbol" > :as< / span > jetty]
[muuntaja.core < span class = "hljs-symbol" > :as< / span > m]
[clojure.java.io < span class = "hljs-symbol" > :as< / span > io]))
2018-05-14 13:54:28 +00:00
(< 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 >
2018-08-22 18:52:18 +00:00
[[< span class = "hljs-string" > " /swagger.json" < / span >
2018-05-14 13:54:28 +00:00
{< span class = "hljs-symbol" > :get< / span > {< span class = "hljs-symbol" > :no-doc< / span > < span class = "hljs-literal" > true< / span >
2019-03-08 06:49:17 +00:00
< 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" > :basePath< / span > < span class = "hljs-string" > " /" < / span > } < span class = "hljs-comment" > ;; prefix for all paths< / span >
2018-05-14 13:54:28 +00:00
< span class = "hljs-symbol" > :handler< / span > (< span class = "hljs-name" > swagger/create-swagger-handler< / span > )}}]
2018-08-22 18:52:18 +00:00
[< span class = "hljs-string" > " /files" < / span >
{< span class = "hljs-symbol" > :swagger< / span > {< span class = "hljs-symbol" > :tags< / span > [< span class = "hljs-string" > " files" < / span > ]}}
[< span class = "hljs-string" > " /upload" < / span >
{< span class = "hljs-symbol" > :post< / span > {< span class = "hljs-symbol" > :summary< / span > < span class = "hljs-string" > " upload a file" < / span >
< span class = "hljs-symbol" > :parameters< / span > {< span class = "hljs-symbol" > :multipart< / span > {< span class = "hljs-symbol" > :file< / span > multipart/temp-file-part}}
< span class = "hljs-symbol" > :responses< / span > {< span class = "hljs-number" > 200< / span > {< span class = "hljs-symbol" > :body< / span > {< span class = "hljs-symbol" > :file< / span > multipart/temp-file-part}}}
< span class = "hljs-symbol" > :handler< / span > (< span class = "hljs-name" > < span class = "hljs-builtin-name" > fn< / span > < / span > [{{{< span class = "hljs-symbol" > :keys< / span > [file]} < span class = "hljs-symbol" > :multipart< / 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" > :file< / span > file}})}}]
[< span class = "hljs-string" > " /download" < / span >
{< span class = "hljs-symbol" > :get< / span > {< span class = "hljs-symbol" > :summary< / span > < span class = "hljs-string" > " downloads a file" < / span >
< span class = "hljs-symbol" > :swagger< / span > {< span class = "hljs-symbol" > :produces< / span > [< span class = "hljs-string" > " image/png" < / span > ]}
< span class = "hljs-symbol" > :handler< / span > (< span class = "hljs-name" > < span class = "hljs-builtin-name" > fn< / span > < / span > [_]
2018-05-14 13:54:28 +00:00
{< span class = "hljs-symbol" > :status< / span > < span class = "hljs-number" > 200< / span >
2018-08-22 18:52:18 +00:00
< span class = "hljs-symbol" > :headers< / span > {< span class = "hljs-string" > " Content-Type" < / span > < span class = "hljs-string" > " image/png" < / span > }
< span class = "hljs-symbol" > :body< / span > (< span class = "hljs-name" > io/input-stream< / span > (< span class = "hljs-name" > io/resource< / span > < span class = "hljs-string" > " reitit.png" < / span > ))})}}]]
2018-05-14 13:54:28 +00:00
2018-08-22 18:52:18 +00:00
[< span class = "hljs-string" > " /math" < / span >
{< span class = "hljs-symbol" > :swagger< / span > {< span class = "hljs-symbol" > :tags< / span > [< span class = "hljs-string" > " math" < / span > ]}}
2018-05-14 13:54:28 +00:00
[< span class = "hljs-string" > " /plus" < / span >
2018-08-22 18:52:18 +00:00
{< span class = "hljs-symbol" > :get< / span > {< span class = "hljs-symbol" > :summary< / span > < span class = "hljs-string" > " plus with spec query parameters" < / 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?}}}
2018-05-14 13:54:28 +00:00
< 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 >
2018-08-22 18:52:18 +00:00
< 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" > :post< / span > {< span class = "hljs-symbol" > :summary< / span > < span class = "hljs-string" > " plus with spec body parameters" < / span >
< span class = "hljs-symbol" > :parameters< / span > {< span class = "hljs-symbol" > :body< / 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" > :body< / 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" > :coercion< / span > reitit.coercion.spec/coercion
< span class = "hljs-symbol" > :muuntaja< / span > m/instance
< span class = "hljs-symbol" > :middleware< / span > [< span class = "hljs-comment" > ;; query-params & form-params< / span >
2018-09-08 07:54:15 +00:00
parameters/parameters-middleware
2018-08-22 18:52:18 +00:00
< span class = "hljs-comment" > ;; content-negotiation< / span >
muuntaja/format-negotiate-middleware
< span class = "hljs-comment" > ;; encoding response body< / span >
muuntaja/format-response-middleware
< span class = "hljs-comment" > ;; exception handling< / span >
exception/exception-middleware
< span class = "hljs-comment" > ;; decoding request body< / span >
muuntaja/format-request-middleware
< span class = "hljs-comment" > ;; coercing response bodys< / span >
coercion/coerce-response-middleware
< span class = "hljs-comment" > ;; coercing request parameters< / span >
coercion/coerce-request-middleware
< span class = "hljs-comment" > ;; multipart< / span >
multipart/multipart-middleware]}})
2018-05-14 13:54:28 +00:00
(< span class = "hljs-name" > ring/routes< / span >
2018-08-22 18:52:18 +00:00
(< span class = "hljs-name" > swagger-ui/create-swagger-ui-handler< / span > {< span class = "hljs-symbol" > :path< / span > < span class = "hljs-string" > " /" < / span > })
2018-05-14 13:54:28 +00:00
(< span class = "hljs-name" > ring/create-default-handler< / span > ))))
(< span class = "hljs-name" > < span class = "hljs-builtin-name" > defn< / span > < / span > start []
(< span class = "hljs-name" > jetty/run-jetty< / span > #' app {< span class = "hljs-symbol" > :port< / span > < span class = "hljs-number" > 3000< / span > , < span class = "hljs-symbol" > :join?< / span > < span class = "hljs-literal" > false< / span > })
(< span class = "hljs-name" > println< / span > < span class = "hljs-string" > " server running in port 3000" < / span > ))
< / code > < / pre >
< p > < a href = "http://localhost:3000" target = "_blank" > http://localhost:3000< / a > should render now the swagger-ui:< / p >
< p > < img src = "../images/swagger.png" alt = "Swagger-ui" > < / p >
2018-07-21 06:48:05 +00:00
< h2 id = "multiple-swagger-apis" > Multiple swagger apis< / h2 >
< p > There can be multiple swagger apis within a router. Each route can be part of 0..n swagger apis. Swagger apis are identified by value in route data under key path < code > [:swagger :id]< / code > . It can be either a keyword or a sequence of keywords. Normal route data < a href = "../basics/route_data.html#nested-route-data" > scoping rules< / a > rules apply.< / p >
2018-05-14 13:54:28 +00:00
< p > Example with:< / p >
< ul >
< li > 4 routes< / li >
< li > 2 swagger apis < code > ::one< / code > and < code > ::two< / code > < / li >
< li > 3 swagger specs< / li >
< / ul >
< 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.swagger < span class = "hljs-symbol" > :as< / span > swagger])
(< span class = "hljs-name" > < span class = "hljs-builtin-name" > def< / span > < / span > ping-route
2018-07-21 07:03:29 +00:00
[< span class = "hljs-string" > " /ping" < / span > {< span class = "hljs-symbol" > :get< / span > (< span class = "hljs-name" > < span class = "hljs-builtin-name" > constantly< / span > < / span > {< span class = "hljs-symbol" > :status< / span > < span class = "hljs-number" > 200< / span > , < span class = "hljs-symbol" > :body< / span > < span class = "hljs-string" > " ping" < / span > })}])
2018-05-14 13:54:28 +00:00
(< span class = "hljs-name" > < span class = "hljs-builtin-name" > def< / span > < / span > spec-route
[< 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" > :handler< / span > (< span class = "hljs-name" > swagger/create-swagger-handler< / span > )}}])
(< 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" > " /common" < / span > {< span class = "hljs-symbol" > :swagger< / span > {< span class = "hljs-symbol" > :id< / span > #{< span class = "hljs-symbol" > ::one< / span > < span class = "hljs-symbol" > ::two< / span > }}} ping-route]
[< span class = "hljs-string" > " /one" < / span > {< span class = "hljs-symbol" > :swagger< / span > {< span class = "hljs-symbol" > :id< / span > < span class = "hljs-symbol" > ::one< / span > }} ping-route spec-route]
[< span class = "hljs-string" > " /two" < / span > {< span class = "hljs-symbol" > :swagger< / span > {< span class = "hljs-symbol" > :id< / span > < span class = "hljs-symbol" > ::two< / span > }} ping-route spec-route
[< span class = "hljs-string" > " /deep" < / span > {< span class = "hljs-symbol" > :swagger< / span > {< span class = "hljs-symbol" > :id< / span > < span class = "hljs-symbol" > ::one< / span > }} ping-route]]
[< span class = "hljs-string" > " /one-two" < / span > {< span class = "hljs-symbol" > :swagger< / span > {< span class = "hljs-symbol" > :id< / span > #{< span class = "hljs-symbol" > ::one< / span > < span class = "hljs-symbol" > ::two< / span > }}} spec-route]])))
< / code > < / pre >
< pre > < code class = "lang-clj" > (< span class = "hljs-name" > < span class = "hljs-builtin-name" > -> < / span > < / span > {< span class = "hljs-symbol" > :request-method< / span > < span class = "hljs-symbol" > :get< / span > , < span class = "hljs-symbol" > :uri< / span > < span class = "hljs-string" > " /one/swagger.json" < / span > } app < span class = "hljs-symbol" > :body< / span > < span class = "hljs-symbol" > :paths< / span > keys)
< span class = "hljs-comment" > ; (" /common/ping" " /one/ping" " /two/deep/ping" )< / span >
< / code > < / pre >
< pre > < code class = "lang-clj" > (< span class = "hljs-name" > < span class = "hljs-builtin-name" > -> < / span > < / span > {< span class = "hljs-symbol" > :request-method< / span > < span class = "hljs-symbol" > :get< / span > , < span class = "hljs-symbol" > :uri< / span > < span class = "hljs-string" > " /two/swagger.json" < / span > } app < span class = "hljs-symbol" > :body< / span > < span class = "hljs-symbol" > :paths< / span > keys)
< span class = "hljs-comment" > ; (" /common/ping" " /two/ping" )< / span >
< / code > < / pre >
< pre > < code class = "lang-clj" > (< span class = "hljs-name" > < span class = "hljs-builtin-name" > -> < / span > < / span > {< span class = "hljs-symbol" > :request-method< / span > < span class = "hljs-symbol" > :get< / span > , < span class = "hljs-symbol" > :uri< / span > < span class = "hljs-string" > " /one-two/swagger.json" < / span > } app < span class = "hljs-symbol" > :body< / span > < span class = "hljs-symbol" > :paths< / span > keys)
< span class = "hljs-comment" > ; (" /common/ping" " /one/ping" " /two/ping" " /two/deep/ping" )< / span >
< / code > < / pre >
< h3 id = "todo" > TODO< / h3 >
< ul >
< li > ClojureScript< ul >
< li > example for < a href = "https://github.com/macchiato-framework" target = "_blank" > Macchiato< / a > < / li >
< li > body formatting< / li >
< li > resource handling< / li >
< / ul >
< / li >
< / ul >
< / 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 >
< a href = "compiling_middleware.html" class = "navigation navigation-prev " aria-label = "Previous page: Compiling Middleware" >
< i class = "fa fa-angle-left" > < / i >
< / a >
2019-01-30 14:34:15 +00:00
< a href = "RESTful_form_methods.html" class = "navigation navigation-next " aria-label = "Next page: RESTful form methods" >
2018-05-14 13:54:28 +00:00
< i class = "fa fa-angle-right" > < / i >
< / a >
< / div >
< script >
var gitbook = gitbook || [];
gitbook.push(function() {
2019-05-22 19:17:48 +00:00
gitbook.page.hasChanged({"page":{"title":"Swagger Support","level":"4.14","depth":1,"next":{"title":"RESTful form methods","level":"4.15","depth":1,"path":"ring/RESTful_form_methods.md","ref":"ring/RESTful_form_methods.md","articles":[]},"previous":{"title":"Compiling Middleware","level":"4.13","depth":1,"path":"ring/compiling_middleware.md","ref":"ring/compiling_middleware.md","articles":[]},"dir":"ltr"},"config":{"plugins":["hints","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":{"github":{"url":"https://github.com/metosin/reitit"},"editlink":{"label":"Edit This Page","multilingual":false,"base":"https://github.com/metosin/reitit/tree/master/doc"},"search":{},"hints":{"danger":"fa fa-exclamation-circle","info":"fa fa-info-circle","tip":"fa fa-mortar-board","working":"fa fa-wrench"},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"highlight":{},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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":"ring/swagger.md","mtime":"2019-05-22T19:17:17.627Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-05-22T19:17:43.863Z"},"basePath":"..","book":{"language":""}});
2018-05-14 13:54:28 +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 >
