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

examples/authorization.cr

@@ -23,15 +23,15 @@ builder = Swagger::Builder.new(
 )
 
 builder.add(Swagger::Controller.new("Auth", "Authorization", [
-  Swagger::Action.new("get", "/access_token", "Get Access Token"),
+  Swagger::Action.new("get", "/access_token", [Swagger::Response.new("200", "Success response")], "Get Access Token"),
 ], external_docs: Swagger::ExternalDocs.new("http://auth.example.com/private_token", "See Details")))
 
 builder.add(Swagger::Controller.new("Users", "User Resources", [
-  Swagger::Action.new("get", "/users", "List users", parameters: [
+  Swagger::Action.new("get", "/users", [Swagger::Response.new("200", "Success response")], "List users", parameters: [
     Swagger::Parameter.new("page", "query", "integer", "Current page"),
     Swagger::Parameter.new("limit", "query", "integer", "How many items to return at one time (max 100)"),
   ], authorization: true),
-  Swagger::Action.new("get", "/users/{id}", "Get user by id", parameters: [Swagger::Parameter.new("id", "path")], responses: [
+  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),

examples/frameworks/kemal.cr

@@ -55,13 +55,13 @@ builder = Swagger::Builder.new(
 )
 
 builder.add(Swagger::Controller.new("Users", "User Resources", [
-  Swagger::Action.new("get", "/users", "List users", parameters: [
+  Swagger::Action.new("get", "/users", description: "List users", parameters: [
     Swagger::Parameter.new("page", "query", "integer", "Current page", default_value: 1),
     Swagger::Parameter.new("limit", "query", "integer", "How many items to return at one time (max 100)", default_value: 10),
   ], responses: [
     Swagger::Response.new("200", "Success response"),
   ]),
-  Swagger::Action.new("get", "/users/{id}", "Get user by id", parameters: [Swagger::Parameter.new("id", "path")], responses: [
+  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"),
   ]),
@@ -75,7 +75,7 @@ builder.add(Swagger::Controller.new("Users", "User Resources", [
       Swagger::Response.new("404", "Not found user"),
     ]
   ),
-  Swagger::Action.new("delete", "/users/{id}", "Get user by id", parameters: [Swagger::Parameter.new("id", "path")], responses: [
+  Swagger::Action.new("delete", "/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"),
   ]),

examples/simple.cr

@@ -19,15 +19,15 @@ builder.add(Swagger::Object.new("User", "object", [
 ]))
 
 builder.add(Swagger::Controller.new("Users", "User Resources", [
-  Swagger::Action.new("get", "/users", "List users", parameters: [
+  Swagger::Action.new("get", "/users", [Swagger::Response.new("200", "Success response")], "List users", parameters: [
     Swagger::Parameter.new("page", "query", "integer", "Current page", default_value: 1, format: "int32"),
     Swagger::Parameter.new("limit", "query", "integer", "How many items to return at one time (max 100)", default_value: 50, format: "int32"),
   ]),
-  Swagger::Action.new("get", "/users/{id}", "Get user by id", parameters: [Swagger::Parameter.new("id", "path")], responses: [
+  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"),
   ], request: Swagger::Request.new("User")),
-  Swagger::Action.new("post", "/users", "Create user",
+  Swagger::Action.new("post", "/users", description: "Create user",
     request: Swagger::Request.new([
       Swagger::Property.new("username", required: true, description: "The name of user"),
       Swagger::Property.new("email", "string", required: true, description: "Email"),
@@ -40,7 +40,7 @@ builder.add(Swagger::Controller.new("Users", "User Resources", [
       Swagger::Response.new("404", "Not found user"),
     ]
   ),
-  Swagger::Action.new("get", "/user/{id}", "Get user by id", parameters: [Swagger::Parameter.new("id", "path")], responses: [
+  Swagger::Action.new("get", "/user/{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"),
   ], deprecated: true),

spec/swagger/action_helper.cr

@@ -0,0 +1,4 @@
+require "spec"
+require "../../src/swagger/response"
+
+OK_RESPONSE = [Swagger::Response.new "200", "OK"]

spec/swagger/action_spec.cr

@@ -1,36 +1,37 @@
-require "../spec_helper"
+require "./action_helper"
+require "../../src/swagger/action"
 
 describe Swagger::Action do
   describe "#new" do
     it "should works" do
-      raw = Swagger::Action.new("get", "/users")
+      raw = Swagger::Action.new("get", "/users", OK_RESPONSE)
       raw.method.should eq "get"
       raw.route.should eq "/users"
+      raw.responses.should eq OK_RESPONSE
       raw.summary.should be_nil
       raw.description.should be_nil
       raw.parameters.should be_nil
       raw.request.should be_nil
-      raw.responses.should be_nil
       raw.authorization.should be_false
       raw.deprecated.should be_false
     end
 
     it "should stored downcase method" do
-      raw = Swagger::Action.new("GET", "/users")
+      raw = Swagger::Action.new("GET", "/users", OK_RESPONSE)
       raw.method.should eq "get"
     end
 
     {% for ivar in Swagger::Objects::PathItem::METHODS %}
       it "should define {{ ivar.id }} method" do
-        raw = Swagger::Action.new("{{ ivar.id }}", "/users")
+        raw = Swagger::Action.new("{{ ivar.id }}", "/users", OK_RESPONSE)
         raw.method.should eq "{{ ivar.id }}"
         raw.route.should eq "/users"
       end
     {% end %}
 
     it "throws an exception with undefined method" do
       expect_raises Swagger::UndefinedMethod do
-        Swagger::Action.new("fake", "/users")
+        Swagger::Action.new("fake", "/users", OK_RESPONSE)
       end
     end
   end

spec/swagger/controller_spec.cr

@@ -1,4 +1,5 @@
-require "../spec_helper"
+require "./action_helper"
+require "../../src/swagger/controller"
 
 describe Swagger::Controller do
   describe "#new" do
@@ -12,11 +13,11 @@ describe Swagger::Controller do
 
     it "should works with actions" do
       raw = Swagger::Controller.new("Users", "User APIs", [
-        Swagger::Action.new("get", "/users", "List Users"),
+        Swagger::Action.new("get", "/users", OK_RESPONSE, "List Users"),
       ])
       raw.name.should eq "Users"
       raw.description.should eq "User APIs"
-      raw.actions.should eq([Swagger::Action.new("get", "/users", "List Users")])
+      raw.actions.should eq([Swagger::Action.new("get", "/users", OK_RESPONSE, "List Users")])
       raw.external_docs.should be_nil
     end
   end

spec/swagger/objects/operation_spec.cr

@@ -1,4 +1,5 @@
-require "../../spec_helper"
+require "./response_helper"
+require "../../../src/swagger/objects/operation"
 
 describe Swagger::Objects::Operation do
   describe ".from" do
@@ -7,13 +8,13 @@ describe Swagger::Objects::Operation do
 
   describe "#new" do
     it "should works" do
-      raw = Swagger::Objects::Operation.new
+      raw = Swagger::Objects::Operation.new SWAGGER_OK_RESPONSE
+      raw.responses.should eq SWAGGER_OK_RESPONSE
       raw.summary.should be_nil
       raw.description.should be_nil
       raw.tags.should be_nil
       raw.parameters.should be_nil
       raw.request_body.should be_nil
-      raw.responses.should be_nil
       raw.deprecated.should be_false
       raw.security.should be_nil
 
@@ -26,13 +27,13 @@ describe Swagger::Objects::Operation do
 
   describe "#to_json" do
     it "should return default hash string" do
-      raw = Swagger::Objects::Operation.new
-      raw.to_json.should eq %Q{{"deprecated":false}}
+      raw = Swagger::Objects::Operation.new SWAGGER_OK_RESPONSE
+      raw.to_json.should eq %Q{{"responses":{"200":{"description":"OK"}},"deprecated":false}}
     end
 
     it "should returns OpenAPI spec Link json string" do
-      raw = Swagger::Objects::Operation.new(request_body: Swagger::Objects::RequestBody.new)
-      raw.to_json.should eq %Q{{"requestBody":{"required":false},"deprecated":false}}
+      raw = Swagger::Objects::Operation.new(SWAGGER_OK_RESPONSE, request_body: Swagger::Objects::RequestBody.new)
+      raw.to_json.should eq %Q{{"requestBody":{"required":false},"responses":{"200":{"description":"OK"}},"deprecated":false}}
     end
   end
 end

spec/swagger/objects/path_item_spec.cr

@@ -1,4 +1,5 @@
-require "../../spec_helper"
+require "./response_helper"
+require "../../../src/swagger/objects/path_item"
 
 describe Swagger::Objects::PathItem do
   describe "#new" do
@@ -21,10 +22,10 @@ describe Swagger::Objects::PathItem do
   describe "#add" do
     it "should works" do
       raw = Swagger::Objects::PathItem.new
-      raw.add("get", Swagger::Objects::Operation.new)
+      raw.add("get", Swagger::Objects::Operation.new SWAGGER_OK_RESPONSE)
       raw.summary.should be_nil
       raw.description.should be_nil
-      raw.get.should eq Swagger::Objects::Operation.new
+      raw.get.should eq Swagger::Objects::Operation.new SWAGGER_OK_RESPONSE
       raw.put.should be_nil
       raw.post.should be_nil
       raw.delete.should be_nil

spec/swagger/objects/response_helper.cr

@@ -0,0 +1,3 @@
+require "spec"
+
+SWAGGER_OK_RESPONSE = {"200" => Swagger::Objects::Response.new "OK"}

src/swagger.cr

@@ -2,11 +2,6 @@ require "json"
 require "./swagger/*"
 
 module Swagger
-  VERSION = "0.1.1"
-
-  OPENAPI_MAJAR_VERSION = "3"
-  OPENAPI_VERSION       = "3.0.1"
-
   alias Document = Objects::Document
   alias Info = Objects::Info
   alias Contact = Objects::Info::Contact

src/swagger/action.cr

@@ -1,3 +1,8 @@
+require "./objects/path_item"
+require "./request"
+require "./response"
+require "./error"
+
 module Swagger
   # Define a action
   #
@@ -18,8 +23,12 @@ module Swagger
     property authorization
     property deprecated
 
-    def initialize(@method : String, @route : String, @summary : String? = nil, @parameters : Array(Parameter)? = nil,
-                   @description : String? = nil, @request : Request? = nil, @responses : Array(Response)? = nil,
+    def initialize(@method : String,
+                   @route : String,
+                   @responses : Array(Response),
+                   @summary : String? = nil,
+                   @parameters : Array(Parameter)? = nil,
+                   @description : String? = nil, @request : Request? = nil,
                    @authorization = false, @deprecated = false)
       unless Objects::PathItem::METHODS.includes?(@method.downcase)
         raise UndefinedMethod.new("Undefined method `#{@method}`, avaiabled in #{Objects::PathItem::METHODS}.")

src/swagger/controller.cr

@@ -1,3 +1,6 @@
+require "./action"
+require "./objects/external_docs"
+
 module Swagger
   # Define a controller
   #