{"id":21931030,"url":"https://github.com/dlive/rest-edoc","last_synced_at":"2026-05-14T21:03:50.619Z","repository":{"id":148636466,"uuid":"56361421","full_name":"DLive/rest-edoc","owner":"DLive","description":"Erlang restful api generate for swagger-ui","archived":false,"fork":false,"pushed_at":"2016-05-06T16:23:30.000Z","size":1562,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-19T19:22:14.960Z","etag":null,"topics":["api","erlang","generate","rest-edoc","restful","swagger"],"latest_commit_sha":null,"homepage":"","language":"Erlang","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DLive.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-04-16T02:31:33.000Z","updated_at":"2023-10-15T09:45:36.000Z","dependencies_parsed_at":"2023-03-30T07:05:02.465Z","dependency_job_id":null,"html_url":"https://github.com/DLive/rest-edoc","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/DLive/rest-edoc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DLive%2Frest-edoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DLive%2Frest-edoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DLive%2Frest-edoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DLive%2Frest-edoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DLive","download_url":"https://codeload.github.com/DLive/rest-edoc/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DLive%2Frest-edoc/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33043249,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-13T13:14:54.681Z","status":"online","status_checked_at":"2026-05-14T02:00:06.663Z","response_time":57,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","erlang","generate","rest-edoc","restful","swagger"],"created_at":"2024-11-28T23:12:31.637Z","updated_at":"2026-05-14T21:03:50.602Z","avatar_url":"https://github.com/DLive.png","language":"Erlang","funding_links":[],"categories":[],"sub_categories":[],"readme":"# rest_edoc\n\tRest_edoc 是一个 restful api 文档生成器，面向 swagger-ui.\n\n# Start\n修改 rebar.conf\n```\n{deps, [\n\t{rest_edoc,\".*\",{git,\"git@github.com:DLive/rest-edoc.git\",{branch,\"master\"}}}\n\t]}.\n{plugins, [rest_edoc]}.\n\n{redoc_opts,[\n\t{target_dir,{your_application,\"priv\"}}\n]}.\n```\n执行 rebar redoc\n执行之后，就会在 your_application/priv目录生成swagger json文件\n\n##示例\n#### 模块说明\n```\n%  @info\n%% @title 微信接口\n%% @description 对接微信公众平台接口\n%% @version 1.0.0\n%% @host isobig.com\n%% @schemes http\n%% @basePath /wechat\n%% @produces application/json\n%% @tag wechat 微信公用\n%% @tag wechat2 微信私有\n```\n\n#### 函数\n```\n%% @path /{wxid}/wx\n%% @tags wechat\n%% @method get\n%% @summary 公众号认证接口.\n%% @description 公众号认证接口\n%% @parameter wxid path string string true 微信公众号ID\n%% @parameter echostr query string string true 输出字符串 defaultValue\n%% @parameter signature query string string true 签名\n%% @parameter timestamp query string string true 时间戳\n%% @parameter nonce query string string true nonce\n%% @parameter2 name=content in=body description=\"用户信息\" required=true schema_$ref=registerinfo \n%% @responses id=default type=schema  schema_$ref=Productabc description=description\n```\n参考说明\n@parameter 变量名  变量类型  值类型 格式化类型 是否必需要 说明 默认值\n@parameter2 name=content in=body description=\"用户信息\" required=true schema_$ref=registerinfo \n\n#### 返回值定义\n```\n%% @definition CustomName object\n%% @propertie id=200 type=string description=descriptiondescriptiondescription\n%% @propertie id=ref_other type=array items_$ref=Activity\n```\n参考说明\n%% @definition 名称 类型\n\n### 参考示例\n```\ncd doc_example\nrebar get-deps\nrebar compile\nrebar redoc \n./test.sh\nopen http://127.0.0.1:7080/index.html\n```\n#### Result\n![image](https://github.com/DLive/rest-edoc/blob/master/example.jpg)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdlive%2Frest-edoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdlive%2Frest-edoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdlive%2Frest-edoc/lists"}