Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

support component parameters #140

Merged
merged 1 commit into from
Sep 22, 2021
Merged

support component parameters #140

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion rebar.config
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@
{cowboy_swagger_handler, trails, 1},
{cowboy_swagger_json_handler, handle_get, 2},
{cowboy_swagger, add_definition_array, 2},
{cowboy_swagger, get_existing_definitions, 1}]}.
{cowboy_swagger, get_existing_definitions, 2}]}.

%% == Dialyzer ==

Expand Down
29 changes: 19 additions & 10 deletions src/cowboy_swagger.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
-export([enc_json/1, dec_json/1]).
-export([swagger_paths/1, validate_metadata/1]).
-export([filter_cowboy_swagger_handler/1]).
-export([get_existing_definitions/1]).
-export([get_existing_definitions/2]).

% is_visible is used as a maps:filter/2 predicate, which requires a /2 arity function
-hank([{unnecessary_function_arguments, [is_visible/2]}]).
Expand Down Expand Up @@ -116,12 +116,20 @@ add_definition(Name, Properties) ->
ok.
add_definition(Definition) ->
CurrentSpec = application:get_env(cowboy_swagger, global_spec, #{}),
NewDefinitions = maps:merge( get_existing_definitions(CurrentSpec)
Type = definition_type(Definition),
NewDefinitions = maps:merge( get_existing_definitions(CurrentSpec, Type)
, Definition
),
NewSpec = prepare_new_global_spec(CurrentSpec, NewDefinitions),
NewSpec = prepare_new_global_spec(CurrentSpec, NewDefinitions, Type),
application:set_env(cowboy_swagger, global_spec, NewSpec).

definition_type(Definition) ->
case maps:values(Definition) of
[#{in := In}] when In =:= query orelse In =:= path orelse In =:= header ->
parameters;
_ -> schemas
end.

-spec schema(DefinitionName::parameter_definition_name()) ->
map().
schema(DefinitionName) ->
Expand Down Expand Up @@ -175,18 +183,18 @@ filter_cowboy_swagger_handler(Trails) ->
end,
lists:filter(F, Trails).

-spec get_existing_definitions(CurrentSpec :: map()) ->
-spec get_existing_definitions(CurrentSpec :: map(), Type :: scheams | parameters) ->
Definition :: parameters_definitions()
| parameters_definition_array().
get_existing_definitions(CurrentSpec) ->
get_existing_definitions(CurrentSpec, Type) ->
case swagger_version() of
swagger_2_0 ->
maps:get(definitions, CurrentSpec, #{});
openapi_3_0_0 ->
case CurrentSpec of
#{components :=
#{schemas := Schemas }} -> Schemas;
_Other -> #{}
#{Type := Def }} -> Def;
_Other -> #{}
end
end.

Expand Down Expand Up @@ -310,7 +318,7 @@ validate_swagger_map_params(Params) ->
ValidateParams =
fun(E) ->
case maps:get(name, E, undefined) of
undefined -> false;
undefined -> maps:is_key(<<"$ref">>, E);
_ -> {true, E#{in => maps:get(in, E, <<"path">>)}}
end
end,
Expand Down Expand Up @@ -347,17 +355,18 @@ build_definition_array(Name, Properties) ->
-spec prepare_new_global_spec( CurrentSpec :: map()
, Definitions :: parameters_definitions()
| parameters_definition_array()
, Type ::schemas|parameters
) ->
NewSpec :: map().
prepare_new_global_spec(CurrentSpec, Definitions) ->
prepare_new_global_spec(CurrentSpec, Definitions, Type) ->
case swagger_version() of
swagger_2_0 ->
CurrentSpec#{definitions => Definitions
};
openapi_3_0_0 ->
Components = maps:get(components, CurrentSpec, #{}),
CurrentSpec#{components =>
Components#{ schemas => Definitions
Components#{ Type => Definitions
}
}
end.
21 changes: 18 additions & 3 deletions test/cowboy_swagger_SUITE.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
, add_definition_test/1
, add_definition_array_test/1
, schema_test/1
, parameters_ref_test/1
]).

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Expand Down Expand Up @@ -173,6 +174,20 @@ schema_test(_Config) ->

{comment, ""}.

-spec parameters_ref_test(Config::cowboy_swagger_test_utils:config()) ->
{comment, string()}.
parameters_ref_test(_Config) ->
set_swagger_version(openapi_3_0_0),
cowboy_swagger:add_definition(
#{<<"page">> =>
#{description => <<"results per page (max 100)">>, example => 1,
in => query, name => per_page,
schema => #{example => 1, maximum => 100, minimum => 1, type => integer}}}),
{ok, SwaggerSpec1} = application:get_env(cowboy_swagger, global_spec),
JsonDefinitions = cowboy_swagger:get_existing_definitions(SwaggerSpec1, parameters),
true = maps:is_key(<<"page">>, JsonDefinitions),
{comment, ""}.

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% Internal functions
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Expand Down Expand Up @@ -208,7 +223,7 @@ perform_add_completed_definition_test() ->
%% Then
%%
{ok, SwaggerSpec1} = application:get_env(cowboy_swagger, global_spec),
JsonDefinitions = cowboy_swagger:get_existing_definitions(SwaggerSpec1),
JsonDefinitions = cowboy_swagger:get_existing_definitions(SwaggerSpec1, schemas),
true = maps:is_key(Name1, JsonDefinitions),
true = maps:is_key(Name2, JsonDefinitions),
ok.
Expand Down Expand Up @@ -236,7 +251,7 @@ perform_add_definition_test() ->
%% Then
%%
{ok, SwaggerSpec1} = application:get_env(cowboy_swagger, global_spec),
JsonDefinitions = cowboy_swagger:get_existing_definitions(SwaggerSpec1),
JsonDefinitions = cowboy_swagger:get_existing_definitions(SwaggerSpec1, schemas),
true = maps:is_key(Name1, JsonDefinitions),
true = maps:is_key(Name2, JsonDefinitions),
ok.
Expand Down Expand Up @@ -264,7 +279,7 @@ perform_add_definition_array_test() ->
%% Then
%%
{ok, SwaggerSpec1} = application:get_env(cowboy_swagger, global_spec),
JsonDefinitions = cowboy_swagger:get_existing_definitions(SwaggerSpec1),
JsonDefinitions = cowboy_swagger:get_existing_definitions(SwaggerSpec1, schemas),
true = maps:is_key(items, maps:get(Name1, JsonDefinitions)),
true = maps:is_key(items, maps:get(Name2, JsonDefinitions)),
<<"array">> = maps:get(type, maps:get(Name1, JsonDefinitions)),
Expand Down