Merge branch 'master' of github.com:icyleaf/swagger

.circleci/config.yml

@@ -2,7 +2,7 @@ version: 2
 jobs:
   build:
     docker:
-      - image: "crystallang/crystal:0.27.0"
+      - image: "crystallang/crystal:0.34.0"
     environment:
       DOCS_PATH: "docs"
       GIT_USER: "icyleaf"

README.md

@@ -26,7 +26,7 @@ builder = Swagger::Builder.new(
   title: "App API",
   version: "1.0.0",
   description: "This is a sample api for users",
-  terms: "http://yourapp.com/terms",
+  terms_url: "http://yourapp.com/terms",
   contact: Swagger::Contact.new("icyleaf", "[email protected]", "http://icyleaf.com"),
   license: Swagger::License.new("MIT", "https://github.com/icyleaf/swagger/blob/master/LICENSE"),
   authorizations: [
@@ -35,21 +35,23 @@ builder = Swagger::Builder.new(
 )
 
 builder.add(Swagger::Controller.new("Users", "User resources", [
-  Swagger::Action.new("get", "/users", "All users"),
-  Swagger::Action.new("get", "/users/{id}", "Get user by id", parameters: [
+  Swagger::Action.new("get", "/users", description: "All users", responses: [
+    Swagger::Response.new("200", "Success response")
+  ]),
+  Swagger::Action.new("get", "/users/{id}", description: "Get user by id", parameters: [
     Swagger::Parameter.new("id", "path")
   ], responses: [
     Swagger::Response.new("200", "Success response"),
     Swagger::Response.new("404", "Not found user")
   ], authorization: true),
-  Swagger::Action.new("post", "/users", "Create User", responses: [
+  Swagger::Action.new("post", "/users", description: "Create User", responses: [
     Swagger::Response.new("201", "Return user resource after created"),
     Swagger::Response.new("401", "Unauthorizated")
   ], authorization: false)
 ]))
 
 document = builder.built
-p document
+puts document.to_json
 ```
 
 ## Structure

shard.yml

@@ -4,6 +4,6 @@ version: 0.2.0
 authors:
   - icyleaf <[email protected]>
 
-crystal: 0.33.0
+crystal: 0.34.0
 
 license: MIT

src/swagger/http/handlers/api.cr

@@ -4,7 +4,9 @@ require "semantic_version"
 module Swagger::HTTP
   class APIHandler
     include Swagger::HTTP::Handler
-
+
+    @json : String
+
     def initialize(document : Document, @endpoint : String, @debug_mode = true)
       major = SemanticVersion.parse(document.openapi_version).major
       @swagger_path = "/v#{major}/swagger.json"

src/swagger/http/handlers/web.cr

@@ -36,7 +36,7 @@ module Swagger::HTTP
     private def asset_uri?(context)
       original_path = context.request.path.not_nil!
       is_dir_path = original_path.ends_with?("/")
-      request_path = self.request_path(URI.decode(original_path))
+      request_path = self.request_path(URI.decode_www_form(original_path))
 
       expanded_path = File.expand_path(request_path, "/")
       if is_dir_path && !expanded_path.ends_with? "/"

src/swagger/objects/security_scheme.cr

@@ -15,6 +15,8 @@ module Swagger::Objects
                  api_key(auth.api_key_name.not_nil!, auth.parameter_location.not_nil!, auth.description)
                when Authorization::Type::OAuth2
                  oauth2(auth.oauth2_flows.not_nil!, auth.description)
+               else
+                 nil
                end
     end