yuanbiao
/
emqx
1
0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

feat: generate API schema files for connectors and bridges

This commit is contained in:
Shawn 2022-06-21 19:04:17 +08:00
parent e4b5c3a9c4
commit 1e6b3b51c0
1 changed files with 28 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
apps/emqx_conf/src/emqx_conf.erl
View File

@ -145,7 +145,7 @@ dump_schema(Dir, SchemaModule, I18nFile) ->
lists:foreach( lists:foreach(
fun(Lang) -> fun(Lang) ->
gen_config_md(Dir, I18nFile, SchemaModule, Lang), gen_config_md(Dir, I18nFile, SchemaModule, Lang),
gen_hot_conf_schema_json(Dir, I18nFile, Lang), gen_api_schema_json(Dir, I18nFile, Lang),
gen_example_conf(filename:dirname(I18nFile), I18nFile, SchemaModule, Lang) gen_example_conf(filename:dirname(I18nFile), I18nFile, SchemaModule, Lang)
end, end,
[en, zh] [en, zh]
@ -161,14 +161,32 @@ gen_schema_json(Dir, I18nFile, SchemaModule) ->
IoData = jsx:encode(JsonMap, [space, {indent, 4}]), IoData = jsx:encode(JsonMap, [space, {indent, 4}]),
ok = file:write_file(SchemaJsonFile, IoData). ok = file:write_file(SchemaJsonFile, IoData).
gen_hot_conf_schema_json(Dir, I18nFile, Lang) -> gen_api_schema_json(Dir, I18nFile, Lang) ->
emqx_dashboard:init_i18n(I18nFile, Lang), emqx_dashboard:init_i18n(I18nFile, Lang),
JsonFile = "hot-config-schema-" ++ atom_to_list(Lang) ++ ".json", gen_api_schema_json_hotconf(Dir, Lang),
HotConfigSchemaFile = filename:join([Dir, JsonFile]), gen_api_schema_json_connector(Dir, Lang),
io:format(user, "===< Generating: ~s~n", [HotConfigSchemaFile]), gen_api_schema_json_bridge(Dir, Lang),
ok = gen_hot_conf_schema(HotConfigSchemaFile),
emqx_dashboard:clear_i18n(). emqx_dashboard:clear_i18n().
gen_api_schema_json_hotconf(Dir, Lang) ->
SchemaInfo = #{title => <<"EMQX Hot Conf API Schema">>, version => <<"0.1.0">>},
File = schema_filename(Dir, "hot-config-schema-", Lang),
ok = do_gen_api_schema_json(File, emqx_mgmt_api_configs, SchemaInfo).
gen_api_schema_json_connector(Dir, Lang) ->
SchemaInfo = #{title => <<"EMQX Connector API Schema">>, version => <<"0.1.0">>},
File = schema_filename(Dir, "connector-api-", Lang),
ok = do_gen_api_schema_json(File, emqx_connector_api, SchemaInfo).
gen_api_schema_json_bridge(Dir, Lang) ->
SchemaInfo = #{title => <<"EMQX Data Bridge API Schema">>, version => <<"0.1.0">>},
File = schema_filename(Dir, "bridge-api-", Lang),
ok = do_gen_api_schema_json(File, emqx_bridge_api, SchemaInfo).
schema_filename(Dir, Prefix, Lang) ->
Filename = Prefix ++ atom_to_list(Lang) ++ ".json",
filename:join([Dir, Filename]).
gen_config_md(Dir, I18nFile, SchemaModule, Lang0) -> gen_config_md(Dir, I18nFile, SchemaModule, Lang0) ->
Lang = atom_to_list(Lang0), Lang = atom_to_list(Lang0),
SchemaMdFile = filename:join([Dir, "config-" ++ Lang ++ ".md"]), SchemaMdFile = filename:join([Dir, "config-" ++ Lang ++ ".md"]),
@ -214,9 +232,10 @@ gen_example(File, SchemaModule, I18nFile, Lang) ->
file:write_file(File, Example). file:write_file(File, Example).
%% Only gen hot_conf schema, not all configuration fields. %% Only gen hot_conf schema, not all configuration fields.
gen_hot_conf_schema(File) -> do_gen_api_schema_json(File, SchemaMod, SchemaInfo) ->
io:format(user, "===< Generating: ~s~n", [File]),
{ApiSpec0, Components0} = emqx_dashboard_swagger:spec( {ApiSpec0, Components0} = emqx_dashboard_swagger:spec(
emqx_mgmt_api_configs, SchemaMod,
#{schema_converter => fun hocon_schema_to_spec/2} #{schema_converter => fun hocon_schema_to_spec/2}
), ),
ApiSpec = lists:foldl( ApiSpec = lists:foldl(
@ -248,7 +267,7 @@ gen_hot_conf_schema(File) ->
Components = lists:foldl(fun(M, Acc) -> maps:merge(M, Acc) end, #{}, Components0), Components = lists:foldl(fun(M, Acc) -> maps:merge(M, Acc) end, #{}, Components0),
IoData = jsx:encode( IoData = jsx:encode(
#{ #{
info => #{title => <<"EMQX Hot Conf Schema">>, version => <<"0.1.0">>}, info => SchemaInfo,
paths => ApiSpec, paths => ApiSpec,
components => #{schemas => Components} components => #{schemas => Components}
}, },